components

package
v0.5.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 8, 2025 License: BSD-2-Clause Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Address 

type Address struct {
	// A street and street number.
	StreetAndNumber *string `json:"streetAndNumber,omitempty"`
	// A postal code. This field may be required if the provided country has a postal code system.
	PostalCode *string `json:"postalCode,omitempty"`
	City       *string `json:"city,omitempty"`
	// A country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
	Country *string `json:"country,omitempty"`
}

func (*Address) GetCity 

func (a *Address) GetCity() *string

func (*Address) GetCountry 

func (a *Address) GetCountry() *string

func (*Address) GetPostalCode 

func (a *Address) GetPostalCode() *string

func (*Address) GetStreetAndNumber 

func (a *Address) GetStreetAndNumber() *string

type Amount 

type Amount struct {
	// A three-character ISO 4217 currency code.
	Currency string `json:"currency" queryParam:"name=currency"`
	// A string containing an exact monetary amount in the given currency.
	Value string `json:"value" queryParam:"name=value"`
}

Amount - In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.

func (*Amount) GetCurrency 

func (a *Amount) GetCurrency() string

func (*Amount) GetValue 

func (a *Amount) GetValue() string

func (Amount) MarshalJSON 

func (a Amount) MarshalJSON() ([]byte, error)

func (*Amount) UnmarshalJSON 

func (a *Amount) UnmarshalJSON(data []byte) error

type AmountNullable 

type AmountNullable struct {
	// A three-character ISO 4217 currency code.
	Currency string `json:"currency"`
	// A string containing an exact monetary amount in the given currency.
	Value string `json:"value"`
}

AmountNullable - In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.

func (*AmountNullable) GetCurrency 

func (a *AmountNullable) GetCurrency() string

func (*AmountNullable) GetValue 

func (a *AmountNullable) GetValue() string

func (AmountNullable) MarshalJSON 

func (a AmountNullable) MarshalJSON() ([]byte, error)

func (*AmountNullable) UnmarshalJSON 

func (a *AmountNullable) UnmarshalJSON(data []byte) error

type AvailableBalance 

type AvailableBalance struct {
	Open                 *SubGroup `json:"open,omitempty"`
	MovedFromPending     *SubGroup `json:"movedFromPending,omitempty"`
	ImmediatelyAvailable *SubGroup `json:"immediatelyAvailable,omitempty"`
	Close                *SubGroup `json:"close,omitempty"`
}

AvailableBalance - The available balance. Only available if grouping is `status-balances`.

func (*AvailableBalance) GetClose 

func (a *AvailableBalance) GetClose() *SubGroup

func (*AvailableBalance) GetImmediatelyAvailable 

func (a *AvailableBalance) GetImmediatelyAvailable() *SubGroup

func (*AvailableBalance) GetMovedFromPending 

func (a *AvailableBalance) GetMovedFromPending() *SubGroup

func (*AvailableBalance) GetOpen 

func (a *AvailableBalance) GetOpen() *SubGroup

type BalanceReportGrouping 

type BalanceReportGrouping string
const (
	BalanceReportGroupingStatusBalances        BalanceReportGrouping = "status-balances"
	BalanceReportGroupingTransactionCategories BalanceReportGrouping = "transaction-categories"
)

func (BalanceReportGrouping) ToPointer 

func (e BalanceReportGrouping) ToPointer() *BalanceReportGrouping

type BalanceStatus 

type BalanceStatus string

BalanceStatus - The status of the balance. 

const (
	BalanceStatusActive   BalanceStatus = "active"
	BalanceStatusInactive BalanceStatus = "inactive"
)

func (BalanceStatus) ToPointer 

func (e BalanceStatus) ToPointer() *BalanceStatus

type BalanceTransactionType 

type BalanceTransactionType string
const (
	BalanceTransactionTypeApplicationFee                    BalanceTransactionType = "application-fee"
	BalanceTransactionTypeCapture                           BalanceTransactionType = "capture"
	BalanceTransactionTypeChargeback                        BalanceTransactionType = "chargeback"
	BalanceTransactionTypeChargebackReversal                BalanceTransactionType = "chargeback-reversal"
	BalanceTransactionTypeFailedPaymentFee                  BalanceTransactionType = "failed-payment-fee"
	BalanceTransactionTypeFailedPayment                     BalanceTransactionType = "failed-payment"
	BalanceTransactionTypeInvoiceCompensation               BalanceTransactionType = "invoice-compensation"
	BalanceTransactionTypePayment                           BalanceTransactionType = "payment"
	BalanceTransactionTypePaymentFee                        BalanceTransactionType = "payment-fee"
	BalanceTransactionTypePaymentCommission                 BalanceTransactionType = "payment-commission"
	BalanceTransactionTypeRefund                            BalanceTransactionType = "refund"
	BalanceTransactionTypeReturnedRefund                    BalanceTransactionType = "returned-refund"
	BalanceTransactionTypeReturnedTransfer                  BalanceTransactionType = "returned-transfer"
	BalanceTransactionTypeSplitPayment                      BalanceTransactionType = "split-payment"
	BalanceTransactionTypeOutgoingTransfer                  BalanceTransactionType = "outgoing-transfer"
	BalanceTransactionTypeCaptureCommission                 BalanceTransactionType = "capture-commission"
	BalanceTransactionTypeCanceledOutgoingTransfer          BalanceTransactionType = "canceled-outgoing-transfer"
	BalanceTransactionTypeIncomingTransfer                  BalanceTransactionType = "incoming-transfer"
	BalanceTransactionTypeAPIPaymentRollingReserveRelease   BalanceTransactionType = "api-payment-rolling-reserve-release"
	BalanceTransactionTypeCaptureRollingReserveRelease      BalanceTransactionType = "capture-rolling-reserve-release"
	BalanceTransactionTypeReimbursementFee                  BalanceTransactionType = "reimbursement-fee"
	BalanceTransactionTypeBalanceCorrection                 BalanceTransactionType = "balance-correction"
	BalanceTransactionTypeUnauthorizedDirectDebit           BalanceTransactionType = "unauthorized-direct-debit"
	BalanceTransactionTypeBankChargedFailureFee             BalanceTransactionType = "bank-charged-failure-fee"
	BalanceTransactionTypePlatformPaymentRefund             BalanceTransactionType = "platform-payment-refund"
	BalanceTransactionTypeRefundCompensation                BalanceTransactionType = "refund-compensation"
	BalanceTransactionTypeReturnedRefundCompensation        BalanceTransactionType = "returned-refund-compensation"
	BalanceTransactionTypeReturnedPlatformPaymentRefund     BalanceTransactionType = "returned-platform-payment-refund"
	BalanceTransactionTypePlatformPaymentChargeback         BalanceTransactionType = "platform-payment-chargeback"
	BalanceTransactionTypeChargebackCompensation            BalanceTransactionType = "chargeback-compensation"
	BalanceTransactionTypeReversedPlatformPaymentChargeback BalanceTransactionType = "reversed-platform-payment-chargeback"
	BalanceTransactionTypeReversedChargebackCompensation    BalanceTransactionType = "reversed-chargeback-compensation"
	BalanceTransactionTypeFailedSplitPaymentPlatform        BalanceTransactionType = "failed-split-payment-platform"
	BalanceTransactionTypeFailedSplitPaymentCompensation    BalanceTransactionType = "failed-split-payment-compensation"
	BalanceTransactionTypeCashAdvanceLoan                   BalanceTransactionType = "cash-advance-loan"
	BalanceTransactionTypePlatformConnectedOrganizationsFee BalanceTransactionType = "platform-connected-organizations-fee"
	BalanceTransactionTypeSplitTransaction                  BalanceTransactionType = "split-transaction"
	BalanceTransactionTypeManagedFee                        BalanceTransactionType = "managed-fee"
	BalanceTransactionTypeReturnedManagedFee                BalanceTransactionType = "returned-managed-fee"
	BalanceTransactionTypeTopup                             BalanceTransactionType = "topup"
	BalanceTransactionTypeBalanceReserve                    BalanceTransactionType = "balance-reserve"
	BalanceTransactionTypeBalanceReserveReturn              BalanceTransactionType = "balance-reserve-return"
	BalanceTransactionTypeMovement                          BalanceTransactionType = "movement"
	BalanceTransactionTypePostPaymentSplitPayment           BalanceTransactionType = "post-payment-split-payment"
	BalanceTransactionTypeCashCollateralIssuance            BalanceTransactionType = "cash-collateral-issuance"
	BalanceTransactionTypeCashCollateralRelease             BalanceTransactionType = "cash-collateral-release"
)

func (BalanceTransactionType) ToPointer 

func (e BalanceTransactionType) ToPointer() *BalanceTransactionType

type BalanceTransferCategory added in v0.5.1 

type BalanceTransferCategory string

BalanceTransferCategory - The type of the transfer. Different fees may apply to different types of transfers. 

const (
	BalanceTransferCategoryInvoiceCollection    BalanceTransferCategory = "invoice_collection"
	BalanceTransferCategoryPurchase             BalanceTransferCategory = "purchase"
	BalanceTransferCategoryChargeback           BalanceTransferCategory = "chargeback"
	BalanceTransferCategoryRefund               BalanceTransferCategory = "refund"
	BalanceTransferCategoryServicePenalty       BalanceTransferCategory = "service_penalty"
	BalanceTransferCategoryDiscountCompensation BalanceTransferCategory = "discount_compensation"
	BalanceTransferCategoryManualCorrection     BalanceTransferCategory = "manual_correction"
	BalanceTransferCategoryOtherFee             BalanceTransferCategory = "other_fee"
)

func (BalanceTransferCategory) ToPointer added in v0.5.1 

func (e BalanceTransferCategory) ToPointer() *BalanceTransferCategory

func (*BalanceTransferCategory) UnmarshalJSON added in v0.5.1 

func (e *BalanceTransferCategory) UnmarshalJSON(data []byte) error

type BalanceTransferCategoryResponse added in v0.5.1 

type BalanceTransferCategoryResponse string

BalanceTransferCategoryResponse - The type of the transfer. Different fees may apply to different types of transfers. 

const (
	BalanceTransferCategoryResponseInvoiceCollection    BalanceTransferCategoryResponse = "invoice_collection"
	BalanceTransferCategoryResponsePurchase             BalanceTransferCategoryResponse = "purchase"
	BalanceTransferCategoryResponseChargeback           BalanceTransferCategoryResponse = "chargeback"
	BalanceTransferCategoryResponseRefund               BalanceTransferCategoryResponse = "refund"
	BalanceTransferCategoryResponseServicePenalty       BalanceTransferCategoryResponse = "service_penalty"
	BalanceTransferCategoryResponseDiscountCompensation BalanceTransferCategoryResponse = "discount_compensation"
	BalanceTransferCategoryResponseManualCorrection     BalanceTransferCategoryResponse = "manual_correction"
	BalanceTransferCategoryResponseOtherFee             BalanceTransferCategoryResponse = "other_fee"
)

func (BalanceTransferCategoryResponse) ToPointer added in v0.5.1 

func (e BalanceTransferCategoryResponse) ToPointer() *BalanceTransferCategoryResponse

type BalanceTransferDestinationType 

type BalanceTransferDestinationType string

BalanceTransferDestinationType - The default destination of automatic scheduled transfers. Currently only `bank-account` is supported.

* `bank-account` — Transfer the balance amount to an external bank account 

const (
	BalanceTransferDestinationTypeBankAccount BalanceTransferDestinationType = "bank-account"
)

func (BalanceTransferDestinationType) ToPointer 

func (e BalanceTransferDestinationType) ToPointer() *BalanceTransferDestinationType

type BalanceTransferFrequency 

type BalanceTransferFrequency string

BalanceTransferFrequency - The frequency with which the available amount on the balance will be settled to the configured transfer destination.

Settlements created during weekends or on bank holidays will take place on the next business day. 

const (
	BalanceTransferFrequencyDaily          BalanceTransferFrequency = "daily"
	BalanceTransferFrequencyEveryMonday    BalanceTransferFrequency = "every-monday"
	BalanceTransferFrequencyEveryTuesday   BalanceTransferFrequency = "every-tuesday"
	BalanceTransferFrequencyEveryWednesday BalanceTransferFrequency = "every-wednesday"
	BalanceTransferFrequencyEveryThursday  BalanceTransferFrequency = "every-thursday"
	BalanceTransferFrequencyEveryFriday    BalanceTransferFrequency = "every-friday"
	BalanceTransferFrequencyMonthly        BalanceTransferFrequency = "monthly"
	BalanceTransferFrequencyNever          BalanceTransferFrequency = "never"
)

func (BalanceTransferFrequency) ToPointer 

func (e BalanceTransferFrequency) ToPointer() *BalanceTransferFrequency

type BalanceTransferPartyType added in v0.5.1 

type BalanceTransferPartyType string

BalanceTransferPartyType - Defines the type of the party. At the moment, only `organization` is supported. 

const (
	BalanceTransferPartyTypeOrganization BalanceTransferPartyType = "organization"
)

func (BalanceTransferPartyType) ToPointer added in v0.5.1 

func (e BalanceTransferPartyType) ToPointer() *BalanceTransferPartyType

func (*BalanceTransferPartyType) UnmarshalJSON added in v0.5.1 

func (e *BalanceTransferPartyType) UnmarshalJSON(data []byte) error

type BalanceTransferPartyTypeResponse added in v0.5.1 

type BalanceTransferPartyTypeResponse string

BalanceTransferPartyTypeResponse - Defines the type of the party. At the moment, only `organization` is supported. 

const (
	BalanceTransferPartyTypeResponseOrganization BalanceTransferPartyTypeResponse = "organization"
)

func (BalanceTransferPartyTypeResponse) ToPointer added in v0.5.1 

func (e BalanceTransferPartyTypeResponse) ToPointer() *BalanceTransferPartyTypeResponse

type BalanceTransferStatus added in v0.5.1 

type BalanceTransferStatus string

BalanceTransferStatus - The status of the transfer. 

const (
	BalanceTransferStatusCreated   BalanceTransferStatus = "created"
	BalanceTransferStatusFailed    BalanceTransferStatus = "failed"
	BalanceTransferStatusSucceeded BalanceTransferStatus = "succeeded"
)

func (BalanceTransferStatus) ToPointer added in v0.5.1 

func (e BalanceTransferStatus) ToPointer() *BalanceTransferStatus

type BalanceTransferStatusReasonResponse added in v0.5.1 

type BalanceTransferStatusReasonResponse string

BalanceTransferStatusReasonResponse - A machine-readable code that indicates the reason for the transfer's status. 

const (
	BalanceTransferStatusReasonResponseRequestCreated            BalanceTransferStatusReasonResponse = "request_created"
	BalanceTransferStatusReasonResponseSuccess                   BalanceTransferStatusReasonResponse = "success"
	BalanceTransferStatusReasonResponseSourceNotAllowed          BalanceTransferStatusReasonResponse = "source_not_allowed"
	BalanceTransferStatusReasonResponseDestinationNotAllowed     BalanceTransferStatusReasonResponse = "destination_not_allowed"
	BalanceTransferStatusReasonResponseInsufficientFunds         BalanceTransferStatusReasonResponse = "insufficient_funds"
	BalanceTransferStatusReasonResponseInvalidSourceBalance      BalanceTransferStatusReasonResponse = "invalid_source_balance"
	BalanceTransferStatusReasonResponseInvalidDestinationBalance BalanceTransferStatusReasonResponse = "invalid_destination_balance"
	BalanceTransferStatusReasonResponseTransferRequestExpired    BalanceTransferStatusReasonResponse = "transfer_request_expired"
	BalanceTransferStatusReasonResponseTransferLimitReached      BalanceTransferStatusReasonResponse = "transfer_limit_reached"
)

func (BalanceTransferStatusReasonResponse) ToPointer added in v0.5.1 

func (e BalanceTransferStatusReasonResponse) ToPointer() *BalanceTransferStatusReasonResponse

type CanceledOutgoingTransfer 

type CanceledOutgoingTransfer struct {
	TransferID   *string `json:"transferId,omitempty"`
	SettlementID *string `json:"settlementId,omitempty"`
}

func (*CanceledOutgoingTransfer) GetSettlementID 

func (c *CanceledOutgoingTransfer) GetSettlementID() *string

func (*CanceledOutgoingTransfer) GetTransferID 

func (c *CanceledOutgoingTransfer) GetTransferID() *string

type CapabilityRequirementStatus 

type CapabilityRequirementStatus string

CapabilityRequirementStatus - The status of the requirement depends on its due date. If no due date is given, the status will be `requested`. 

const (
	CapabilityRequirementStatusCurrentlyDue CapabilityRequirementStatus = "currently-due"
	CapabilityRequirementStatusPastDue      CapabilityRequirementStatus = "past-due"
	CapabilityRequirementStatusRequested    CapabilityRequirementStatus = "requested"
)

func (CapabilityRequirementStatus) ToPointer 

func (e CapabilityRequirementStatus) ToPointer() *CapabilityRequirementStatus

type CapabilityStatus 

type CapabilityStatus string
const (
	CapabilityStatusUnrequested CapabilityStatus = "unrequested"
	CapabilityStatusEnabled     CapabilityStatus = "enabled"
	CapabilityStatusDisabled    CapabilityStatus = "disabled"
	CapabilityStatusPending     CapabilityStatus = "pending"
)

func (CapabilityStatus) ToPointer 

func (e CapabilityStatus) ToPointer() *CapabilityStatus

type CapabilityStatusReason 

type CapabilityStatusReason string
const (
	CapabilityStatusReasonRequirementPastDue          CapabilityStatusReason = "requirement-past-due"
	CapabilityStatusReasonOnboardingInformationNeeded CapabilityStatusReason = "onboarding-information-needed"
)

func (CapabilityStatusReason) ToPointer 

func (e CapabilityStatusReason) ToPointer() *CapabilityStatusReason

type Capital 

type Capital struct {
	Pending              *SubGroup `json:"pending,omitempty"`
	MovedToAvailable     *SubGroup `json:"movedToAvailable,omitempty"`
	ImmediatelyAvailable *SubGroup `json:"immediatelyAvailable,omitempty"`
}

Capital - Only available on `transaction-categories` grouping.

func (*Capital) GetImmediatelyAvailable 

func (c *Capital) GetImmediatelyAvailable() *SubGroup

func (*Capital) GetMovedToAvailable 

func (c *Capital) GetMovedToAvailable() *SubGroup

func (*Capital) GetPending 

func (c *Capital) GetPending() *SubGroup

type Capture 

type Capture struct {
	PaymentID          *string `json:"paymentId,omitempty"`
	PaymentDescription *string `json:"paymentDescription,omitempty"`
	CaptureID          *string `json:"captureId,omitempty"`
	CaptureDescription *string `json:"captureDescription,omitempty"`
}

func (*Capture) GetCaptureDescription 

func (c *Capture) GetCaptureDescription() *string

func (*Capture) GetCaptureID 

func (c *Capture) GetCaptureID() *string

func (*Capture) GetPaymentDescription 

func (c *Capture) GetPaymentDescription() *string

func (*Capture) GetPaymentID 

func (c *Capture) GetPaymentID() *string

type CaptureCommision 

type CaptureCommision struct {
	PaymentID          *string `json:"paymentId,omitempty"`
	PaymentDescription *string `json:"paymentDescription,omitempty"`
	CaptureID          *string `json:"captureId,omitempty"`
	CaptureDescription *string `json:"captureDescription,omitempty"`
}

func (*CaptureCommision) GetCaptureDescription 

func (c *CaptureCommision) GetCaptureDescription() *string

func (*CaptureCommision) GetCaptureID 

func (c *CaptureCommision) GetCaptureID() *string

func (*CaptureCommision) GetPaymentDescription 

func (c *CaptureCommision) GetPaymentDescription() *string

func (*CaptureCommision) GetPaymentID 

func (c *CaptureCommision) GetPaymentID() *string

type CaptureMode 

type CaptureMode string

CaptureMode - Indicate if the funds should be captured immediately or if you want to [place a hold](https://docs.mollie.com/docs/place-a-hold-for-a-payment#/) and capture at a later time.

This field needs to be set to `manual` for method `riverty`. 

const (
	CaptureModeAutomatic CaptureMode = "automatic"
	CaptureModeManual    CaptureMode = "manual"
)

func (CaptureMode) ToPointer 

func (e CaptureMode) ToPointer() *CaptureMode

func (*CaptureMode) UnmarshalJSON 

func (e *CaptureMode) UnmarshalJSON(data []byte) error

type CaptureModeResponse 

type CaptureModeResponse string

CaptureModeResponse - Indicate if the funds should be captured immediately or if you want to [place a hold](https://docs.mollie.com/docs/place-a-hold-for-a-payment#/) and capture at a later time.

This field needs to be set to `manual` for method `riverty`. 

const (
	CaptureModeResponseAutomatic CaptureModeResponse = "automatic"
	CaptureModeResponseManual    CaptureModeResponse = "manual"
)

func (CaptureModeResponse) ToPointer 

func (e CaptureModeResponse) ToPointer() *CaptureModeResponse

type CaptureResponse 

type CaptureResponse struct {
	// Indicates the response contains a capture object. Will always contain the string `capture` for this endpoint.
	Resource *string `json:"resource,omitempty"`
	ID       *string `json:"id,omitempty"`
	// Whether this entity was created in live mode or in test mode.
	Mode *Mode `json:"mode,omitempty"`
	// The description of the capture.
	Description *string `json:"description,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount *AmountNullable `json:"amount,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	SettlementAmount *AmountNullable `json:"settlementAmount,omitempty"`
	// The capture's status.
	Status *CaptureStatus `json:"status,omitempty"`
	// Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever
	// you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
	Metadata     *Metadata `json:"metadata,omitempty"`
	PaymentID    *string   `json:"paymentId,omitempty"`
	ShipmentID   *string   `json:"shipmentId,omitempty"`
	SettlementID *string   `json:"settlementId,omitempty"`
	// The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	CreatedAt *string `json:"createdAt,omitempty"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links *CaptureResponseLinks `json:"_links,omitempty"`
}

func (*CaptureResponse) GetAmount 

func (c *CaptureResponse) GetAmount() *AmountNullable

func (*CaptureResponse) GetCreatedAt 

func (c *CaptureResponse) GetCreatedAt() *string

func (*CaptureResponse) GetDescription 

func (c *CaptureResponse) GetDescription() *string

func (*CaptureResponse) GetID 

func (c *CaptureResponse) GetID() *string
func (c *CaptureResponse) GetLinks() *CaptureResponseLinks

func (*CaptureResponse) GetMetadata 

func (c *CaptureResponse) GetMetadata() *Metadata

func (*CaptureResponse) GetMode 

func (c *CaptureResponse) GetMode() *Mode

func (*CaptureResponse) GetPaymentID 

func (c *CaptureResponse) GetPaymentID() *string

func (*CaptureResponse) GetResource 

func (c *CaptureResponse) GetResource() *string

func (*CaptureResponse) GetSettlementAmount 

func (c *CaptureResponse) GetSettlementAmount() *AmountNullable

func (*CaptureResponse) GetSettlementID 

func (c *CaptureResponse) GetSettlementID() *string

func (*CaptureResponse) GetShipmentID 

func (c *CaptureResponse) GetShipmentID() *string

func (*CaptureResponse) GetStatus 

func (c *CaptureResponse) GetStatus() *CaptureStatus
type CaptureResponseLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self URLObj `json:"self"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Payment URLObj `json:"payment"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Settlement *URLNullable `json:"settlement,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Shipment *URLNullable `json:"shipment,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation URLObj `json:"documentation"`
}

CaptureResponseLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.

func (*CaptureResponseLinks) GetDocumentation 

func (c *CaptureResponseLinks) GetDocumentation() URLObj

func (*CaptureResponseLinks) GetPayment 

func (c *CaptureResponseLinks) GetPayment() URLObj

func (*CaptureResponseLinks) GetSelf 

func (c *CaptureResponseLinks) GetSelf() URLObj

func (*CaptureResponseLinks) GetSettlement 

func (c *CaptureResponseLinks) GetSettlement() *URLNullable

func (*CaptureResponseLinks) GetShipment 

func (c *CaptureResponseLinks) GetShipment() *URLNullable

type CaptureRollingReserveRelease 

type CaptureRollingReserveRelease struct {
	PaymentID          *string `json:"paymentId,omitempty"`
	PaymentDescription *string `json:"paymentDescription,omitempty"`
	CaptureID          *string `json:"captureId,omitempty"`
	CaptureDescription *string `json:"captureDescription,omitempty"`
}

func (*CaptureRollingReserveRelease) GetCaptureDescription 

func (c *CaptureRollingReserveRelease) GetCaptureDescription() *string

func (*CaptureRollingReserveRelease) GetCaptureID 

func (c *CaptureRollingReserveRelease) GetCaptureID() *string

func (*CaptureRollingReserveRelease) GetPaymentDescription 

func (c *CaptureRollingReserveRelease) GetPaymentDescription() *string

func (*CaptureRollingReserveRelease) GetPaymentID 

func (c *CaptureRollingReserveRelease) GetPaymentID() *string

type CaptureStatus 

type CaptureStatus string

CaptureStatus - The capture's status. 

const (
	CaptureStatusPending   CaptureStatus = "pending"
	CaptureStatusSucceeded CaptureStatus = "succeeded"
	CaptureStatusFailed    CaptureStatus = "failed"
)

func (CaptureStatus) ToPointer 

func (e CaptureStatus) ToPointer() *CaptureStatus

type Chargeback 

type Chargeback struct {
	PaymentID             *string `json:"paymentId,omitempty"`
	PaymentDescription    *string `json:"paymentDescription,omitempty"`
	ChargebackID          *string `json:"chargebackId,omitempty"`
	ChargebackDescription *string `json:"chargebackDescription,omitempty"`
}

func (*Chargeback) GetChargebackDescription 

func (c *Chargeback) GetChargebackDescription() *string

func (*Chargeback) GetChargebackID 

func (c *Chargeback) GetChargebackID() *string

func (*Chargeback) GetPaymentDescription 

func (c *Chargeback) GetPaymentDescription() *string

func (*Chargeback) GetPaymentID 

func (c *Chargeback) GetPaymentID() *string

type ChargebackCompensation 

type ChargebackCompensation struct {
	PaymentID             *string `json:"paymentId,omitempty"`
	PaymentDescription    *string `json:"paymentDescription,omitempty"`
	ChargebackID          *string `json:"chargebackId,omitempty"`
	ChargebackDescription *string `json:"chargebackDescription,omitempty"`
}

func (*ChargebackCompensation) GetChargebackDescription 

func (c *ChargebackCompensation) GetChargebackDescription() *string

func (*ChargebackCompensation) GetChargebackID 

func (c *ChargebackCompensation) GetChargebackID() *string

func (*ChargebackCompensation) GetPaymentDescription 

func (c *ChargebackCompensation) GetPaymentDescription() *string

func (*ChargebackCompensation) GetPaymentID 

func (c *ChargebackCompensation) GetPaymentID() *string

type ChargebackReversal 

type ChargebackReversal struct {
	PaymentID             *string `json:"paymentId,omitempty"`
	PaymentDescription    *string `json:"paymentDescription,omitempty"`
	ChargebackID          *string `json:"chargebackId,omitempty"`
	ChargebackDescription *string `json:"chargebackDescription,omitempty"`
}

func (*ChargebackReversal) GetChargebackDescription 

func (c *ChargebackReversal) GetChargebackDescription() *string

func (*ChargebackReversal) GetChargebackID 

func (c *ChargebackReversal) GetChargebackID() *string

func (*ChargebackReversal) GetPaymentDescription 

func (c *ChargebackReversal) GetPaymentDescription() *string

func (*ChargebackReversal) GetPaymentID 

func (c *ChargebackReversal) GetPaymentID() *string

type Chargebacks 

type Chargebacks struct {
	Pending              *SubGroup `json:"pending,omitempty"`
	MovedToAvailable     *SubGroup `json:"movedToAvailable,omitempty"`
	ImmediatelyAvailable *SubGroup `json:"immediatelyAvailable,omitempty"`
}

Chargebacks - Only available on `transaction-categories` grouping.

func (*Chargebacks) GetImmediatelyAvailable 

func (c *Chargebacks) GetImmediatelyAvailable() *SubGroup

func (*Chargebacks) GetMovedToAvailable 

func (c *Chargebacks) GetMovedToAvailable() *SubGroup

func (*Chargebacks) GetPending 

func (c *Chargebacks) GetPending() *SubGroup

type Close 

type Close struct {
	Pending   *SubGroup `json:"pending,omitempty"`
	Available *SubGroup `json:"available,omitempty"`
}

Close - Only available on `transaction-categories` grouping.

func (*Close) GetAvailable 

func (c *Close) GetAvailable() *SubGroup

func (*Close) GetPending 

func (c *Close) GetPending() *SubGroup

type Code 

type Code string

Code - A machine-readable code that indicates the reason for the payment's status. 

const (
	CodeApprovedOrCompletedSuccessfully             Code = "approved_or_completed_successfully"
	CodeReferToCardIssuer                           Code = "refer_to_card_issuer"
	CodeInvalidMerchant                             Code = "invalid_merchant"
	CodeCaptureCard                                 Code = "capture_card"
	CodeDoNotHonor                                  Code = "do_not_honor"
	CodeError                                       Code = "error"
	CodePartialApproval                             Code = "partial_approval"
	CodeInvalidTransaction                          Code = "invalid_transaction"
	CodeInvalidAmount                               Code = "invalid_amount"
	CodeInvalidIssuer                               Code = "invalid_issuer"
	CodeLostCard                                    Code = "lost_card"
	CodeStolenCard                                  Code = "stolen_card"
	CodeInsufficientFunds                           Code = "insufficient_funds"
	CodeExpiredCard                                 Code = "expired_card"
	CodeInvalidPin                                  Code = "invalid_pin"
	CodeTransactionNotPermittedToCardholder         Code = "transaction_not_permitted_to_cardholder"
	CodeTransactionNotAllowedAtTerminal             Code = "transaction_not_allowed_at_terminal"
	CodeExceedsWithdrawalAmountLimit                Code = "exceeds_withdrawal_amount_limit"
	CodeRestrictedCard                              Code = "restricted_card"
	CodeSecurityViolation                           Code = "security_violation"
	CodeExceedsWithdrawalCountLimit                 Code = "exceeds_withdrawal_count_limit"
	CodeAllowableNumberOfPinTriesExceeded           Code = "allowable_number_of_pin_tries_exceeded"
	CodeNoReasonToDecline                           Code = "no_reason_to_decline"
	CodeCannotVerifyPin                             Code = "cannot_verify_pin"
	CodeIssuerUnavailable                           Code = "issuer_unavailable"
	CodeUnableToRouteTransaction                    Code = "unable_to_route_transaction"
	CodeDuplicateTransaction                        Code = "duplicate_transaction"
	CodeSystemMalfunction                           Code = "system_malfunction"
	CodeHonorWithID                                 Code = "honor_with_id"
	CodeInvalidCardNumber                           Code = "invalid_card_number"
	CodeFormatError                                 Code = "format_error"
	CodeContactCardIssuer                           Code = "contact_card_issuer"
	CodePinNotChanged                               Code = "pin_not_changed"
	CodeInvalidNonexistentToAccountSpecified        Code = "invalid_nonexistent_to_account_specified"
	CodeInvalidNonexistentFromAccountSpecified      Code = "invalid_nonexistent_from_account_specified"
	CodeInvalidNonexistentAccountSpecified          Code = "invalid_nonexistent_account_specified"
	CodeLifecycleRelated                            Code = "lifecycle_related"
	CodeDomesticDebitTransactionNotAllowed          Code = "domestic_debit_transaction_not_allowed"
	CodePolicyRelated                               Code = "policy_related"
	CodeFraudSecurityRelated                        Code = "fraud_security_related"
	CodeInvalidAuthorizationLifeCycle               Code = "invalid_authorization_life_cycle"
	CodePurchaseAmountOnlyNoCashBackAllowed         Code = "purchase_amount_only_no_cash_back_allowed"
	CodeCryptographicFailure                        Code = "cryptographic_failure"
	CodeUnacceptablePin                             Code = "unacceptable_pin"
	CodeReferToCardIssuerSpecialCondition           Code = "refer_to_card_issuer_special_condition"
	CodePickUpCardSpecialCondition                  Code = "pick_up_card_special_condition"
	CodeVipApproval                                 Code = "vip_approval"
	CodeInvalidAccountNumber                        Code = "invalid_account_number"
	CodeReEnterTransaction                          Code = "re_enter_transaction"
	CodeNoActionTaken                               Code = "no_action_taken"
	CodeUnableToLocateRecord                        Code = "unable_to_locate_record"
	CodeFileTemporarilyUnavailable                  Code = "file_temporarily_unavailable"
	CodeNoCreditAccount                             Code = "no_credit_account"
	CodeClosedAccount                               Code = "closed_account"
	CodeNoCheckingAccount                           Code = "no_checking_account"
	CodeNoSavingsAccount                            Code = "no_savings_account"
	CodeSuspectedFraud                              Code = "suspected_fraud"
	CodeTransactionDoesNotFulfillAmlRequirement     Code = "transaction_does_not_fulfill_aml_requirement"
	CodePinDataRequired                             Code = "pin_data_required"
	CodeUnableToLocatePreviousMessage               Code = "unable_to_locate_previous_message"
	CodePreviousMessageLocatedInconsistentData      Code = "previous_message_located_inconsistent_data"
	CodeBlockedFirstUsed                            Code = "blocked_first_used"
	CodeTransactionReversed                         Code = "transaction_reversed"
	CodeCreditIssuerUnavailable                     Code = "credit_issuer_unavailable"
	CodePinCryptographicErrorFound                  Code = "pin_cryptographic_error_found"
	CodeNegativeOnlineCamResult                     Code = "negative_online_cam_result"
	CodeViolationOfLaw                              Code = "violation_of_law"
	CodeForceStip                                   Code = "force_stip"
	CodeCashServiceNotAvailable                     Code = "cash_service_not_available"
	CodeCashbackRequestExceedsIssuerLimit           Code = "cashback_request_exceeds_issuer_limit"
	CodeDeclineForCvv2Failure                       Code = "decline_for_cvv2_failure"
	CodeTransactionAmountExceedsPreAuthorizedAmount Code = "transaction_amount_exceeds_pre_authorized_amount"
	CodeInvalidBillerInformation                    Code = "invalid_biller_information"
	CodePinChangeUnblockRequestDeclined             Code = "pin_change_unblock_request_declined"
	CodeUnsafePin                                   Code = "unsafe_pin"
	CodeCardAuthenticationFailed                    Code = "card_authentication_failed"
	CodeStopPaymentOrder                            Code = "stop_payment_order"
	CodeRevocationOfAuthorization                   Code = "revocation_of_authorization"
	CodeRevocationOfAllAuthorizations               Code = "revocation_of_all_authorizations"
	CodeForwardToIssuerXa                           Code = "forward_to_issuer_xa"
	CodeForwardToIssuerXd                           Code = "forward_to_issuer_xd"
	CodeUnableToGoOnline                            Code = "unable_to_go_online"
	CodeAdditionalCustomerAuthenticationRequired    Code = "additional_customer_authentication_required"
	CodeMerchantIDNotFound                          Code = "merchant_id_not_found"
	CodeMerchantAccountClosed                       Code = "merchant_account_closed"
	CodeTerminalIDNotFound                          Code = "terminal_id_not_found"
	CodeTerminalClosed                              Code = "terminal_closed"
	CodeInvalidCategoryCode                         Code = "invalid_category_code"
	CodeInvalidCurrency                             Code = "invalid_currency"
	CodeMissingCvv2Cvc2                             Code = "missing_cvv2_cvc2"
	CodeCvv2NotAllowed                              Code = "cvv2_not_allowed"
	CodeMerchantNotRegisteredVbv                    Code = "merchant_not_registered_vbv"
	CodeMerchantNotRegisteredForAmex                Code = "merchant_not_registered_for_amex"
	CodeTransactionNotPermittedAtTerminal           Code = "transaction_not_permitted_at_terminal"
	CodeAgreementTerminalNotRelated                 Code = "agreement_terminal_not_related"
	CodeInvalidProcessorID                          Code = "invalid_processor_id"
	CodeInvalidMerchantData                         Code = "invalid_merchant_data"
	CodeSubMerchantAccountClosed                    Code = "sub_merchant_account_closed"
	CodeTerminalBusy                                Code = "terminal_busy"
	CodeTerminalUnreachable                         Code = "terminal_unreachable"
	CodeServiceFailed                               Code = "service_failed"
	CodeInvalidOperation                            Code = "invalid_operation"
	CodeAuthorizationError                          Code = "authorization_error"
	CodeLoginFailedWithoutReason                    Code = "login_failed_without_reason"
	CodeInvalidRetailer                             Code = "invalid_retailer"
	CodeCardDoesNotExist                            Code = "card_does_not_exist"
	CodeCardIsBlocked                               Code = "card_is_blocked"
	CodeInvalidCardID                               Code = "invalid_card_id"
	CodeCardIsTransferred                           Code = "card_is_transferred"
	CodeCardIsNotActive                             Code = "card_is_not_active"
	CodeIncorrectPurchaseValue                      Code = "incorrect_purchase_value"
	CodeCardNotAvailable                            Code = "card_not_available"
	CodeWrongCurrency                               Code = "wrong_currency"
	CodeLoginFailedUnknownUser                      Code = "login_failed_unknown_user"
	CodeLoginFailedInvalidPassword                  Code = "login_failed_invalid_password"
	CodeInvalidEanCode                              Code = "invalid_ean_code"
)

func (Code) ToPointer 

func (e Code) ToPointer() *Code

func (*Code) UnmarshalJSON 

func (e *Code) UnmarshalJSON(data []byte) error

type Company 

type Company struct {
	// The organization's registration number.
	RegistrationNumber *string `json:"registrationNumber,omitempty"`
	// The organization's VAT number.
	VatNumber *string `json:"vatNumber,omitempty"`
	// The organization's entity type.
	EntityType *string `json:"entityType,omitempty"`
}

Company - Billie is a business-to-business (B2B) payment method. It requires extra information to identify the organization that is completing the payment. It is recommended to include these parameters up front for a seamless flow. Otherwise, Billie will ask the customer to complete the missing fields during checkout.

func (*Company) GetEntityType 

func (c *Company) GetEntityType() *string

func (*Company) GetRegistrationNumber 

func (c *Company) GetRegistrationNumber() *string

func (*Company) GetVatNumber 

func (c *Company) GetVatNumber() *string

type ComponentsSubTotals 

type ComponentsSubTotals struct {
	SubTotals []SubTotals `json:"sub-totals,omitempty"`
	// Number of transactions of this type
	Count *int64 `json:"count,omitempty"`
	// The payment method, if applicable
	Method *PaymentMethod `json:"method,omitempty"`
	// In case of payments transactions with card, the card issuer will be available
	CardIssuer *ComponentsSubTotalsCardIssuer `json:"cardIssuer,omitempty"`
	// In case of payments trnsactions with card, the card audience will be available.
	CardAudience *ComponentsSubTotalsCardAudience `json:"cardAudience,omitempty"`
	// In case of payments transactions with card, the card region will be available.
	CardRegion *ComponentsSubTotalsCardRegion `json:"cardRegion,omitempty"`
	// Present when the transaction represents a fee.
	FeeType *ComponentsSubTotalsFeeType `json:"feeType,omitempty"`
	// Prepayment part: fee itself, reimbursement, discount, VAT or rounding compensation.
	PrepaymentPartType *ComponentsSubTotalsPrepaymentPartType `json:"prepaymentPartType,omitempty"`
	// Represents the transaction type
	TransactionType *ComponentsSubTotalsTransactionType `json:"transactionType,omitempty"`
}

func (*ComponentsSubTotals) GetCardAudience 

func (c *ComponentsSubTotals) GetCardAudience() *ComponentsSubTotalsCardAudience

func (*ComponentsSubTotals) GetCardIssuer 

func (c *ComponentsSubTotals) GetCardIssuer() *ComponentsSubTotalsCardIssuer

func (*ComponentsSubTotals) GetCardRegion 

func (c *ComponentsSubTotals) GetCardRegion() *ComponentsSubTotalsCardRegion

func (*ComponentsSubTotals) GetCount 

func (c *ComponentsSubTotals) GetCount() *int64

func (*ComponentsSubTotals) GetFeeType 

func (c *ComponentsSubTotals) GetFeeType() *ComponentsSubTotalsFeeType

func (*ComponentsSubTotals) GetMethod 

func (c *ComponentsSubTotals) GetMethod() *PaymentMethod

func (*ComponentsSubTotals) GetPrepaymentPartType 

func (c *ComponentsSubTotals) GetPrepaymentPartType() *ComponentsSubTotalsPrepaymentPartType

func (*ComponentsSubTotals) GetSubTotals 

func (c *ComponentsSubTotals) GetSubTotals() []SubTotals

func (*ComponentsSubTotals) GetTransactionType 

func (c *ComponentsSubTotals) GetTransactionType() *ComponentsSubTotalsTransactionType

type ComponentsSubTotalsCardAudience 

type ComponentsSubTotalsCardAudience string

ComponentsSubTotalsCardAudience - In case of payments trnsactions with card, the card audience will be available. 

const (
	ComponentsSubTotalsCardAudienceCorporate ComponentsSubTotalsCardAudience = "corporate"
	ComponentsSubTotalsCardAudienceOther     ComponentsSubTotalsCardAudience = "other"
)

func (ComponentsSubTotalsCardAudience) ToPointer 

func (e ComponentsSubTotalsCardAudience) ToPointer() *ComponentsSubTotalsCardAudience

func (*ComponentsSubTotalsCardAudience) UnmarshalJSON 

func (e *ComponentsSubTotalsCardAudience) UnmarshalJSON(data []byte) error

type ComponentsSubTotalsCardIssuer 

type ComponentsSubTotalsCardIssuer string

ComponentsSubTotalsCardIssuer - In case of payments transactions with card, the card issuer will be available 

const (
	ComponentsSubTotalsCardIssuerAmex          ComponentsSubTotalsCardIssuer = "amex"
	ComponentsSubTotalsCardIssuerMaestro       ComponentsSubTotalsCardIssuer = "maestro"
	ComponentsSubTotalsCardIssuerCarteBancaire ComponentsSubTotalsCardIssuer = "carte-bancaire"
	ComponentsSubTotalsCardIssuerOther         ComponentsSubTotalsCardIssuer = "other"
)

func (ComponentsSubTotalsCardIssuer) ToPointer 

func (e ComponentsSubTotalsCardIssuer) ToPointer() *ComponentsSubTotalsCardIssuer

func (*ComponentsSubTotalsCardIssuer) UnmarshalJSON 

func (e *ComponentsSubTotalsCardIssuer) UnmarshalJSON(data []byte) error

type ComponentsSubTotalsCardRegion 

type ComponentsSubTotalsCardRegion string

ComponentsSubTotalsCardRegion - In case of payments transactions with card, the card region will be available. 

const (
	ComponentsSubTotalsCardRegionIntraEea ComponentsSubTotalsCardRegion = "intra-eea"
	ComponentsSubTotalsCardRegionIntraEu  ComponentsSubTotalsCardRegion = "intra-eu"
	ComponentsSubTotalsCardRegionDomestic ComponentsSubTotalsCardRegion = "domestic"
	ComponentsSubTotalsCardRegionOther    ComponentsSubTotalsCardRegion = "other"
)

func (ComponentsSubTotalsCardRegion) ToPointer 

func (e ComponentsSubTotalsCardRegion) ToPointer() *ComponentsSubTotalsCardRegion

func (*ComponentsSubTotalsCardRegion) UnmarshalJSON 

func (e *ComponentsSubTotalsCardRegion) UnmarshalJSON(data []byte) error

type ComponentsSubTotalsFeeType 

type ComponentsSubTotalsFeeType string

ComponentsSubTotalsFeeType - Present when the transaction represents a fee. 

const (
	ComponentsSubTotalsFeeTypePaymentFee                                        ComponentsSubTotalsFeeType = "payment-fee"
	ComponentsSubTotalsFeeTypeDirectDebitFailureFee                             ComponentsSubTotalsFeeType = "direct-debit-failure-fee"
	ComponentsSubTotalsFeeTypeUnauthorizedDirectDebitFee                        ComponentsSubTotalsFeeType = "unauthorized-direct-debit-fee"
	ComponentsSubTotalsFeeTypeBankChargedDirectDebitFailureFee                  ComponentsSubTotalsFeeType = "bank-charged-direct-debit-failure-fee"
	ComponentsSubTotalsFeeTypePartnerCommission                                 ComponentsSubTotalsFeeType = "partner-commission"
	ComponentsSubTotalsFeeTypeApplicationFee                                    ComponentsSubTotalsFeeType = "application-fee"
	ComponentsSubTotalsFeeTypeCaptureFee                                        ComponentsSubTotalsFeeType = "capture-fee"
	ComponentsSubTotalsFeeTypeRefundFee                                         ComponentsSubTotalsFeeType = "refund-fee"
	ComponentsSubTotalsFeeTypeChargebackFee                                     ComponentsSubTotalsFeeType = "chargeback-fee"
	ComponentsSubTotalsFeeTypePaymentNotificationFee                            ComponentsSubTotalsFeeType = "payment-notification-fee"
	ComponentsSubTotalsFeeTypeTransferNotificationFee                           ComponentsSubTotalsFeeType = "transfer-notification-fee"
	ComponentsSubTotalsFeeTypePayoutFee                                         ComponentsSubTotalsFeeType = "payout-fee"
	ComponentsSubTotalsFeeTypeFeeDiscount                                       ComponentsSubTotalsFeeType = "fee-discount"
	ComponentsSubTotalsFeeTypeFeeReimbursement                                  ComponentsSubTotalsFeeType = "fee-reimbursement"
	ComponentsSubTotalsFeeTypePlatformVolumeFee                                 ComponentsSubTotalsFeeType = "platform-volume-fee"
	ComponentsSubTotalsFeeTypePlatformConnectedOrganizationsFee                 ComponentsSubTotalsFeeType = "platform-connected-organizations-fee"
	ComponentsSubTotalsFeeTypeBalanceChargeFee                                  ComponentsSubTotalsFeeType = "balance-charge-fee"
	ComponentsSubTotalsFeeTypeThreedsAuthenticationAttemptFee                   ComponentsSubTotalsFeeType = "3ds-authentication-attempt-fee"
	ComponentsSubTotalsFeeTypeTerminalMonthlyFee                                ComponentsSubTotalsFeeType = "terminal-monthly-fee"
	ComponentsSubTotalsFeeTypeAcceptanceRiskFee                                 ComponentsSubTotalsFeeType = "acceptance-risk-fee"
	ComponentsSubTotalsFeeTypeTopUpFee                                          ComponentsSubTotalsFeeType = "top-up-fee"
	ComponentsSubTotalsFeeTypePaymentGatewayFee                                 ComponentsSubTotalsFeeType = "payment-gateway-fee"
	ComponentsSubTotalsFeeTypeMastercardSpecialtyMerchantProgramProcessingFee   ComponentsSubTotalsFeeType = "mastercard-specialty-merchant-program-processing-fee"
	ComponentsSubTotalsFeeTypeMastercardSpecialtyMerchantProgramRegistrationFee ComponentsSubTotalsFeeType = "mastercard-specialty-merchant-program-registration-fee"
	ComponentsSubTotalsFeeTypeVisaIntegrityRiskProgramProcessingFee             ComponentsSubTotalsFeeType = "visa-integrity-risk-program-processing-fee"
	ComponentsSubTotalsFeeTypeVisaIntegrityRiskProgramRegistrationFee           ComponentsSubTotalsFeeType = "visa-integrity-risk-program-registration-fee"
	ComponentsSubTotalsFeeTypeMinimumInvoiceAmountFee                           ComponentsSubTotalsFeeType = "minimum-invoice-amount-fee"
)

func (ComponentsSubTotalsFeeType) ToPointer 

func (e ComponentsSubTotalsFeeType) ToPointer() *ComponentsSubTotalsFeeType

func (*ComponentsSubTotalsFeeType) UnmarshalJSON 

func (e *ComponentsSubTotalsFeeType) UnmarshalJSON(data []byte) error

type ComponentsSubTotalsPrepaymentPartType 

type ComponentsSubTotalsPrepaymentPartType string

ComponentsSubTotalsPrepaymentPartType - Prepayment part: fee itself, reimbursement, discount, VAT or rounding compensation. 

const (
	ComponentsSubTotalsPrepaymentPartTypeFee                     ComponentsSubTotalsPrepaymentPartType = "fee"
	ComponentsSubTotalsPrepaymentPartTypeFeeReimbursement        ComponentsSubTotalsPrepaymentPartType = "fee-reimbursement"
	ComponentsSubTotalsPrepaymentPartTypeFeeDiscount             ComponentsSubTotalsPrepaymentPartType = "fee-discount"
	ComponentsSubTotalsPrepaymentPartTypeFeeVat                  ComponentsSubTotalsPrepaymentPartType = "fee-vat"
	ComponentsSubTotalsPrepaymentPartTypeFeeRoundingCompensation ComponentsSubTotalsPrepaymentPartType = "fee-rounding-compensation"
)

func (ComponentsSubTotalsPrepaymentPartType) ToPointer 

func (e ComponentsSubTotalsPrepaymentPartType) ToPointer() *ComponentsSubTotalsPrepaymentPartType

func (*ComponentsSubTotalsPrepaymentPartType) UnmarshalJSON 

func (e *ComponentsSubTotalsPrepaymentPartType) UnmarshalJSON(data []byte) error

type ComponentsSubTotalsTransactionType 

type ComponentsSubTotalsTransactionType string

ComponentsSubTotalsTransactionType - Represents the transaction type 

const (
	ComponentsSubTotalsTransactionTypePayment                           ComponentsSubTotalsTransactionType = "payment"
	ComponentsSubTotalsTransactionTypeSplitPayment                      ComponentsSubTotalsTransactionType = "split-payment"
	ComponentsSubTotalsTransactionTypeFailedPayment                     ComponentsSubTotalsTransactionType = "failed-payment"
	ComponentsSubTotalsTransactionTypeFailedPlatformSplitPayment        ComponentsSubTotalsTransactionType = "failed-platform-split-payment"
	ComponentsSubTotalsTransactionTypeFailedSplitPaymentCompensation    ComponentsSubTotalsTransactionType = "failed-split-payment-compensation"
	ComponentsSubTotalsTransactionTypeCapture                           ComponentsSubTotalsTransactionType = "capture"
	ComponentsSubTotalsTransactionTypeSplitTransaction                  ComponentsSubTotalsTransactionType = "split-transaction"
	ComponentsSubTotalsTransactionTypeRefund                            ComponentsSubTotalsTransactionType = "refund"
	ComponentsSubTotalsTransactionTypePlatformPaymentRefund             ComponentsSubTotalsTransactionType = "platform-payment-refund"
	ComponentsSubTotalsTransactionTypeReturnedPlatformPaymentRefund     ComponentsSubTotalsTransactionType = "returned-platform-payment-refund"
	ComponentsSubTotalsTransactionTypeRefundCompensation                ComponentsSubTotalsTransactionType = "refund-compensation"
	ComponentsSubTotalsTransactionTypeReturnedRefundCompensation        ComponentsSubTotalsTransactionType = "returned-refund-compensation"
	ComponentsSubTotalsTransactionTypeReturnedRefund                    ComponentsSubTotalsTransactionType = "returned-refund"
	ComponentsSubTotalsTransactionTypeChargeback                        ComponentsSubTotalsTransactionType = "chargeback"
	ComponentsSubTotalsTransactionTypeChargebackReversal                ComponentsSubTotalsTransactionType = "chargeback-reversal"
	ComponentsSubTotalsTransactionTypeChargebackCompensation            ComponentsSubTotalsTransactionType = "chargeback-compensation"
	ComponentsSubTotalsTransactionTypeReversedChargebackCompensation    ComponentsSubTotalsTransactionType = "reversed-chargeback-compensation"
	ComponentsSubTotalsTransactionTypePlatformPaymentChargeback         ComponentsSubTotalsTransactionType = "platform-payment-chargeback"
	ComponentsSubTotalsTransactionTypeReversedPlatformPaymentChargeback ComponentsSubTotalsTransactionType = "reversed-platform-payment-chargeback"
	ComponentsSubTotalsTransactionTypeFeePrepayment                     ComponentsSubTotalsTransactionType = "fee-prepayment"
	ComponentsSubTotalsTransactionTypeOutgoingTransfer                  ComponentsSubTotalsTransactionType = "outgoing-transfer"
	ComponentsSubTotalsTransactionTypeIncomingTransfer                  ComponentsSubTotalsTransactionType = "incoming-transfer"
	ComponentsSubTotalsTransactionTypeCanceledTransfer                  ComponentsSubTotalsTransactionType = "canceled-transfer"
	ComponentsSubTotalsTransactionTypeReturnedTransfer                  ComponentsSubTotalsTransactionType = "returned-transfer"
	ComponentsSubTotalsTransactionTypeBalanceReserve                    ComponentsSubTotalsTransactionType = "balance-reserve"
	ComponentsSubTotalsTransactionTypeBalanceReserveReturn              ComponentsSubTotalsTransactionType = "balance-reserve-return"
	ComponentsSubTotalsTransactionTypeInvoiceRoundingCompensation       ComponentsSubTotalsTransactionType = "invoice-rounding-compensation"
	ComponentsSubTotalsTransactionTypeRollingReserveHold                ComponentsSubTotalsTransactionType = "rolling-reserve-hold"
	ComponentsSubTotalsTransactionTypeRollingReserveRelease             ComponentsSubTotalsTransactionType = "rolling-reserve-release"
	ComponentsSubTotalsTransactionTypeBalanceCorrection                 ComponentsSubTotalsTransactionType = "balance-correction"
	ComponentsSubTotalsTransactionTypeRepayment                         ComponentsSubTotalsTransactionType = "repayment"
	ComponentsSubTotalsTransactionTypeLoan                              ComponentsSubTotalsTransactionType = "loan"
	ComponentsSubTotalsTransactionTypeBalanceTopup                      ComponentsSubTotalsTransactionType = "balance-topup"
	ComponentsSubTotalsTransactionTypeCashCollateralIssuance            ComponentsSubTotalsTransactionType = "cash-collateral-issuance';"
	ComponentsSubTotalsTransactionTypeCashCollateralRelease             ComponentsSubTotalsTransactionType = "cash-collateral-release"
	ComponentsSubTotalsTransactionTypePendingRollingReserve             ComponentsSubTotalsTransactionType = "pending-rolling-reserve"
	ComponentsSubTotalsTransactionTypeToBeReleasedRollingReserve        ComponentsSubTotalsTransactionType = "to-be-released-rolling-reserve"
	ComponentsSubTotalsTransactionTypeHeldRollingReserve                ComponentsSubTotalsTransactionType = "held-rolling-reserve"
	ComponentsSubTotalsTransactionTypeReleasedRollingReserve            ComponentsSubTotalsTransactionType = "released-rolling-reserve"
)

func (ComponentsSubTotalsTransactionType) ToPointer 

func (e ComponentsSubTotalsTransactionType) ToPointer() *ComponentsSubTotalsTransactionType

func (*ComponentsSubTotalsTransactionType) UnmarshalJSON 

func (e *ComponentsSubTotalsTransactionType) UnmarshalJSON(data []byte) error

type Context 

type Context struct {
	Payment                           *Payment                                `json:"payment,omitempty"`
	Capture                           *Capture                                `json:"capture,omitempty"`
	CaptureCommision                  *CaptureCommision                       `json:"capture-commision,omitempty"`
	CaptureRollingReserveRelease      *CaptureRollingReserveRelease           `json:"capture-rolling-reserve-release,omitempty"`
	UnauthorizedDirectDebit           *UnauthorizedDirectDebit                `json:"unauthorized-direct-debit,omitempty"`
	FailedPayment                     *FailedPayment                          `json:"failed-payment,omitempty"`
	Refund                            *Refund                                 `json:"refund,omitempty"`
	RefundCompensation                *RefundCompensation                     `json:"refund-compensation,omitempty"`
	ReturnedRefund                    *ReturnedRefund                         `json:"returned-refund,omitempty"`
	ReturnedRefundCompensation        *ReturnedRefundCompensation             `json:"returned-refund-compensation,omitempty"`
	Chargeback                        *Chargeback                             `json:"chargeback,omitempty"`
	ChargebackReversal                *ChargebackReversal                     `json:"chargeback-reversal,omitempty"`
	ChargebackCompensation            *ChargebackCompensation                 `json:"chargeback-compensation,omitempty"`
	ReversedChargebackCompensation    *ReversedChargebackCompensation         `json:"reversed-chargeback-compensation,omitempty"`
	OutgoingTransfer                  *OutgoingTransfer                       `json:"outgoing-transfer,omitempty"`
	CanceledOutgoingTransfer          *CanceledOutgoingTransfer               `json:"canceled-outgoing-transfer,omitempty"`
	ReturnedTransfer                  *ReturnedTransfer                       `json:"returned-transfer,omitempty"`
	InvoiceCompensation               *InvoiceCompensation                    `json:"invoice-compensation,omitempty"`
	ApplicationFee                    *EntityBalanceTransactionApplicationFee `json:"application-fee,omitempty"`
	SplitPayment                      *SplitPayment                           `json:"split-payment,omitempty"`
	PlatformPaymentRefund             *PlatformPaymentRefund                  `json:"platform-payment-refund,omitempty"`
	ReturnedPlatformPaymentRefund     *ReturnedPlatformPaymentRefund          `json:"returned-platform-payment-refund,omitempty"`
	PlatformPaymentChargeback         *PlatformPaymentChargeback              `json:"platform-payment-chargeback,omitempty"`
	ReversedPlatformPaymentChargeback *ReversedPlatformPaymentChargeback      `json:"reversed-platform-payment-chargeback,omitempty"`
	PaymentCommission                 *PaymentCommission                      `json:"payment-commission,omitempty"`
	ReimbursementFee                  *ReimbursementFee                       `json:"reimbursement-fee,omitempty"`
	FailedPaymentFee                  *FailedPaymentFee                       `json:"failed-payment-fee,omitempty"`
	PaymentFee                        *PaymentFee                             `json:"payment-fee,omitempty"`
	ManagedFee                        *ManagedFee                             `json:"managed-fee,omitempty"`
	ReturnedManagedFee                *ReturnedManagedFee                     `json:"returned-managed-fee,omitempty"`
	PostPaymentSplitPayment           *PostPaymentSplitPayment                `json:"post-payment-split-payment,omitempty"`
}

Context - Depending on the type of the balance transaction, we will try to give more context about the specific event that triggered it. For example, the context object for a payment transaction will look like `{"paymentId": "tr_5B8cwPMGnU6qLbRvo7qEZo", "paymentDescription": "Description"}`.

Below is a complete list of the context values that each type of transaction will have.

* Type `payment`: `paymentId`, `paymentDescription` * Type `capture`: `paymentId` `captureId`, `paymentDescription`, `captureDescription` * Type `capture-commission`: `paymentId`, `paymentDescription`, `organizationId` * Type `capture-rolling-reserve-release`: `paymentId`, `paymentDescription`, `captureId`, `captureDescription` * Type `unauthorized-direct-debit`: `paymentId`, `paymentDescription` * Type `failed-payment`: `paymentId`, `paymentDescription` * Type `refund`: `paymentId` `refundId`, `paymentDescription`, `refundDescription` * Type `refund-compensation`: `paymentId` `refundId`, `paymentDescription`, `refundDescription` * Type `returned-refund`: `paymentId` `refundId`, `paymentDescription`, `refundDescription` * Type `returned-refund-compensation`: `paymentId` `refundId`, `paymentDescription`, `refundDescription` * Type `chargeback`: `paymentId` `chargebackId`, `paymentDescription`, `chargebackDescription` * Type `chargeback-reversal`: `paymentId`, `chargebackId`, `paymentDescription`, `chargebackDescription` * Type `chargeback-compensation`: `paymentId`, `chargebackId`, `paymentDescription`, `chargebackDescription` * Type `reversed-chargeback-compensation`: `paymentId`, `chargebackId`, `paymentDescription`, `chargebackDescription` * Type `outgoing-transfer`: `settlementId` `transferId` * Type `canceled-outgoing-transfer`: `settlementId` `transferId` * Type `returned-transfer`: `settlementId` `transferId` * Type `invoice-compensation`: `invoiceId` * Type `balance-correction`: none * Type `application-fee`: `paymentId`, `paymentDescription`, `payingOwner` * Type `split-payment`: `paymentId`, `paymentDescription`, `paymentOwner` * Type `platform-payment-refund`: `paymentId` `refundId`, `paymentDescription`, `refundDescription` * Type `returned-platform-payment-refund`: `paymentId` `refundId`, `paymentDescription`, `refundDescription` * Type `platform-payment-chargeback`: `paymentId` `chargebackId`, `paymentDescription`, `chargebackDescription` * Type `reversed-platform-payment-chargeback`: `paymentId` `chargebackId`, `paymentDescription`, `chargebackDescription` * Type `payment-commission`: `paymentId`, `paymentDescription`, `organizationId` * Type `reimbursement-fee`: `paymentId`, `paymentDescription` * Type `failed-payment-fee`: `paymentId`, `paymentDescription` * Type `payment-fee`: `paymentId`, `paymentDescription` * Type `cash-advance-loan`: none * Type `platform-connected-organizations-fee`: none * Type `managed-fee`: `feeType`, `<name of the fee>Id` * Type `returned-managed-fee`: `feeType`, `<name of the fee>Id` * Type `topup`: none * Type `balance-reserve`: none * Type `balance-reserve-return`: none * Type `movement`: none * Type `post-payment-split-payment`: `paymentId` * Type `cash-collateral-issuance`: none * Type `cash-collateral-release`: none

func (*Context) GetApplicationFee 

func (c *Context) GetApplicationFee() *EntityBalanceTransactionApplicationFee

func (*Context) GetCanceledOutgoingTransfer 

func (c *Context) GetCanceledOutgoingTransfer() *CanceledOutgoingTransfer

func (*Context) GetCapture 

func (c *Context) GetCapture() *Capture

func (*Context) GetCaptureCommision 

func (c *Context) GetCaptureCommision() *CaptureCommision

func (*Context) GetCaptureRollingReserveRelease 

func (c *Context) GetCaptureRollingReserveRelease() *CaptureRollingReserveRelease

func (*Context) GetChargeback 

func (c *Context) GetChargeback() *Chargeback

func (*Context) GetChargebackCompensation 

func (c *Context) GetChargebackCompensation() *ChargebackCompensation

func (*Context) GetChargebackReversal 

func (c *Context) GetChargebackReversal() *ChargebackReversal

func (*Context) GetFailedPayment 

func (c *Context) GetFailedPayment() *FailedPayment

func (*Context) GetFailedPaymentFee 

func (c *Context) GetFailedPaymentFee() *FailedPaymentFee

func (*Context) GetInvoiceCompensation 

func (c *Context) GetInvoiceCompensation() *InvoiceCompensation

func (*Context) GetManagedFee 

func (c *Context) GetManagedFee() *ManagedFee

func (*Context) GetOutgoingTransfer 

func (c *Context) GetOutgoingTransfer() *OutgoingTransfer

func (*Context) GetPayment 

func (c *Context) GetPayment() *Payment

func (*Context) GetPaymentCommission 

func (c *Context) GetPaymentCommission() *PaymentCommission

func (*Context) GetPaymentFee 

func (c *Context) GetPaymentFee() *PaymentFee

func (*Context) GetPlatformPaymentChargeback 

func (c *Context) GetPlatformPaymentChargeback() *PlatformPaymentChargeback

func (*Context) GetPlatformPaymentRefund 

func (c *Context) GetPlatformPaymentRefund() *PlatformPaymentRefund

func (*Context) GetPostPaymentSplitPayment 

func (c *Context) GetPostPaymentSplitPayment() *PostPaymentSplitPayment

func (*Context) GetRefund 

func (c *Context) GetRefund() *Refund

func (*Context) GetRefundCompensation 

func (c *Context) GetRefundCompensation() *RefundCompensation

func (*Context) GetReimbursementFee 

func (c *Context) GetReimbursementFee() *ReimbursementFee

func (*Context) GetReturnedManagedFee 

func (c *Context) GetReturnedManagedFee() *ReturnedManagedFee

func (*Context) GetReturnedPlatformPaymentRefund 

func (c *Context) GetReturnedPlatformPaymentRefund() *ReturnedPlatformPaymentRefund

func (*Context) GetReturnedRefund 

func (c *Context) GetReturnedRefund() *ReturnedRefund

func (*Context) GetReturnedRefundCompensation 

func (c *Context) GetReturnedRefundCompensation() *ReturnedRefundCompensation

func (*Context) GetReturnedTransfer 

func (c *Context) GetReturnedTransfer() *ReturnedTransfer

func (*Context) GetReversedChargebackCompensation 

func (c *Context) GetReversedChargebackCompensation() *ReversedChargebackCompensation

func (*Context) GetReversedPlatformPaymentChargeback 

func (c *Context) GetReversedPlatformPaymentChargeback() *ReversedPlatformPaymentChargeback

func (*Context) GetSplitPayment 

func (c *Context) GetSplitPayment() *SplitPayment

func (*Context) GetUnauthorizedDirectDebit 

func (c *Context) GetUnauthorizedDirectDebit() *UnauthorizedDirectDebit

type Corrections 

type Corrections struct {
	Pending              *SubGroup `json:"pending,omitempty"`
	MovedToAvailable     *SubGroup `json:"movedToAvailable,omitempty"`
	ImmediatelyAvailable *SubGroup `json:"immediatelyAvailable,omitempty"`
}

Corrections - Only available on `transaction-categories` grouping.

func (*Corrections) GetImmediatelyAvailable 

func (c *Corrections) GetImmediatelyAvailable() *SubGroup

func (*Corrections) GetMovedToAvailable 

func (c *Corrections) GetMovedToAvailable() *SubGroup

func (*Corrections) GetPending 

func (c *Corrections) GetPending() *SubGroup

type Cost added in v0.4.2 

type Cost struct {
	// A description of the cost subtotal
	Description string `json:"description"`
	// The payment method, if applicable
	Method *PaymentMethod `json:"method"`
	// The number of fees
	Count int64 `json:"count"`
	// The service rates, further divided into `fixed` and `percentage` costs.
	Rate Rate `json:"rate"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	AmountNet Amount `json:"amountNet"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	AmountVat *AmountNullable `json:"amountVat"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	AmountGross Amount `json:"amountGross"`
}

func (*Cost) GetAmountGross added in v0.4.2 

func (c *Cost) GetAmountGross() Amount

func (*Cost) GetAmountNet added in v0.4.2 

func (c *Cost) GetAmountNet() Amount

func (*Cost) GetAmountVat added in v0.4.2 

func (c *Cost) GetAmountVat() *AmountNullable

func (*Cost) GetCount added in v0.4.2 

func (c *Cost) GetCount() int64

func (*Cost) GetDescription added in v0.4.2 

func (c *Cost) GetDescription() string

func (*Cost) GetMethod added in v0.4.2 

func (c *Cost) GetMethod() *PaymentMethod

func (*Cost) GetRate added in v0.4.2 

func (c *Cost) GetRate() Rate

type CreateWebhook 

type CreateWebhook struct {
	// Indicates the response contains a webhook subscription object. Will always contain the string `webhook` for this endpoint.
	Resource string `json:"resource"`
	// The identifier uniquely referring to this subscription.
	ID string `json:"id"`
	// The subscription's events destination.
	URL string `json:"url"`
	// The identifier uniquely referring to the profile that created the subscription.
	ProfileID string `json:"profileId"`
	// The subscription's date time of creation.
	CreatedAt string `json:"createdAt"`
	// The subscription's name.
	Name string `json:"name"`
	// The events types that are subscribed.
	EventTypes []WebhookEventTypes `json:"eventTypes"`
	// The subscription's current status.
	Status WebhookStatus `json:"status"`
	// Whether this entity was created in live mode or in test mode.
	Mode Mode `json:"mode"`
	// The subscription's secret.
	WebhookSecret string `json:"webhookSecret"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links CreateWebhookLinks `json:"_links"`
}

func (*CreateWebhook) GetCreatedAt 

func (c *CreateWebhook) GetCreatedAt() string

func (*CreateWebhook) GetEventTypes 

func (c *CreateWebhook) GetEventTypes() []WebhookEventTypes

func (*CreateWebhook) GetID 

func (c *CreateWebhook) GetID() string
func (c *CreateWebhook) GetLinks() CreateWebhookLinks

func (*CreateWebhook) GetMode 

func (c *CreateWebhook) GetMode() Mode

func (*CreateWebhook) GetName 

func (c *CreateWebhook) GetName() string

func (*CreateWebhook) GetProfileID 

func (c *CreateWebhook) GetProfileID() string

func (*CreateWebhook) GetResource 

func (c *CreateWebhook) GetResource() string

func (*CreateWebhook) GetStatus 

func (c *CreateWebhook) GetStatus() WebhookStatus

func (*CreateWebhook) GetURL 

func (c *CreateWebhook) GetURL() string

func (*CreateWebhook) GetWebhookSecret 

func (c *CreateWebhook) GetWebhookSecret() string
type CreateWebhookLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self URLObj `json:"self"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation URLObj `json:"documentation"`
}

CreateWebhookLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.

func (*CreateWebhookLinks) GetDocumentation 

func (c *CreateWebhookLinks) GetDocumentation() URLObj

func (*CreateWebhookLinks) GetSelf added in v0.5.1 

func (c *CreateWebhookLinks) GetSelf() URLObj

type Currencies 

type Currencies string
const (
	CurrenciesEur Currencies = "EUR"
	CurrenciesGbp Currencies = "GBP"
	CurrenciesChf Currencies = "CHF"
	CurrenciesDkk Currencies = "DKK"
	CurrenciesNok Currencies = "NOK"
	CurrenciesPln Currencies = "PLN"
	CurrenciesSek Currencies = "SEK"
	CurrenciesUsd Currencies = "USD"
	CurrenciesCzk Currencies = "CZK"
	CurrenciesHuf Currencies = "HUF"
	CurrenciesAud Currencies = "AUD"
	CurrenciesCad Currencies = "CAD"
)

func (Currencies) ToPointer 

func (e Currencies) ToPointer() *Currencies

type CustomerResponse 

type CustomerResponse struct {
	// Indicates the response contains a customer object. Will always contain the string `customer` for this endpoint.
	Resource *string `json:"resource,omitempty"`
	ID       *string `json:"id,omitempty"`
	// Whether this entity was created in live mode or in test mode.
	Mode *Mode `json:"mode,omitempty"`
	// The full name of the customer.
	Name *string `json:"name,omitempty"`
	// The email address of the customer.
	Email *string `json:"email,omitempty"`
	// Allows you to preset the language to be used.
	Locale *LocaleResponse `json:"locale,omitempty"`
	// Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever
	// you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
	Metadata *Metadata `json:"metadata,omitempty"`
	// The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	CreatedAt *string `json:"createdAt,omitempty"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links *CustomerResponseLinks `json:"_links,omitempty"`
}

func (*CustomerResponse) GetCreatedAt 

func (c *CustomerResponse) GetCreatedAt() *string

func (*CustomerResponse) GetEmail 

func (c *CustomerResponse) GetEmail() *string

func (*CustomerResponse) GetID 

func (c *CustomerResponse) GetID() *string
func (c *CustomerResponse) GetLinks() *CustomerResponseLinks

func (*CustomerResponse) GetLocale 

func (c *CustomerResponse) GetLocale() *LocaleResponse

func (*CustomerResponse) GetMetadata 

func (c *CustomerResponse) GetMetadata() *Metadata

func (*CustomerResponse) GetMode 

func (c *CustomerResponse) GetMode() *Mode

func (*CustomerResponse) GetName 

func (c *CustomerResponse) GetName() *string

func (*CustomerResponse) GetResource 

func (c *CustomerResponse) GetResource() *string
type CustomerResponseLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self URLObj `json:"self"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Dashboard URLObj `json:"dashboard"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Payments *URLNullable `json:"payments,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Mandates *URLNullable `json:"mandates,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Subscriptions *URLNullable `json:"subscriptions,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation URLObj `json:"documentation"`
}

CustomerResponseLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.

func (*CustomerResponseLinks) GetDashboard 

func (c *CustomerResponseLinks) GetDashboard() URLObj

func (*CustomerResponseLinks) GetDocumentation 

func (c *CustomerResponseLinks) GetDocumentation() URLObj

func (*CustomerResponseLinks) GetMandates 

func (c *CustomerResponseLinks) GetMandates() *URLNullable

func (*CustomerResponseLinks) GetPayments 

func (c *CustomerResponseLinks) GetPayments() *URLNullable

func (*CustomerResponseLinks) GetSelf 

func (c *CustomerResponseLinks) GetSelf() URLObj

func (*CustomerResponseLinks) GetSubscriptions 

func (c *CustomerResponseLinks) GetSubscriptions() *URLNullable

type Dashboard 

type Dashboard struct {
	// The actual URL string.
	Href *string `json:"href,omitempty"`
	// The content type of the page or endpoint the URL points to.
	Type *string `json:"type,omitempty"`
}

Dashboard - If known, a deep link to the Mollie dashboard of the client, where the requirement can be fulfilled. For example, where necessary documents are to be uploaded.

func (*Dashboard) GetHref 

func (d *Dashboard) GetHref() *string

func (*Dashboard) GetType 

func (d *Dashboard) GetType() *string

type DeleteValuesSalesInvoice 

type DeleteValuesSalesInvoice struct {
	// Most API credentials are specifically created for either live mode or test mode. For organization-level credentials
	// such as OAuth access tokens, you can enable test mode by setting `testmode` to `true`.
	//
	// Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
	Testmode *bool `json:"testmode,omitempty"`
}

func (*DeleteValuesSalesInvoice) GetTestmode 

func (d *DeleteValuesSalesInvoice) GetTestmode() *bool

type Documentation 

type Documentation struct {
	Href string `json:"href"`
	Type string `json:"type"`
}

Documentation - The URL to the generic Mollie API error handling guide.

func (*Documentation) GetHref 

func (d *Documentation) GetHref() string

func (*Documentation) GetType 

func (d *Documentation) GetType() string

type Embedded 

type Embedded struct {
	Entity *Entity `json:"entity,omitempty"`
}

Embedded - Full payload of the event.

func (*Embedded) GetEntity 

func (e *Embedded) GetEntity() *Entity

type Entity 

type Entity struct {
	PaymentLinkResponse   *PaymentLinkResponse   `queryParam:"inline,name=entity"`
	EntityProfileResponse *EntityProfileResponse `queryParam:"inline,name=entity"`

	Type EntityType
}

func CreateEntityEntityProfileResponse 

func CreateEntityEntityProfileResponse(entityProfileResponse EntityProfileResponse) Entity

func CreateEntityPaymentLinkResponse 

func CreateEntityPaymentLinkResponse(paymentLinkResponse PaymentLinkResponse) Entity

func (Entity) MarshalJSON 

func (u Entity) MarshalJSON() ([]byte, error)

func (*Entity) UnmarshalJSON 

func (u *Entity) UnmarshalJSON(data []byte) error

type EntityBalance 

type EntityBalance struct {
	// Indicates the response contains a balance object. Will always contain the string `balance` for this endpoint.
	Resource *string `json:"resource,omitempty"`
	ID       *string `json:"id,omitempty"`
	// Whether this entity was created in live mode or in test mode.
	Mode *Mode `json:"mode,omitempty"`
	// The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	CreatedAt *string     `json:"createdAt,omitempty"`
	Currency  *Currencies `json:"currency,omitempty"`
	// The description or name of the balance. Can be used to denote the purpose of the balance.
	Description *string `json:"description,omitempty"`
	// The status of the balance.
	Status *BalanceStatus `json:"status,omitempty"`
	// The frequency with which the available amount on the balance will be settled to the configured transfer
	// destination.
	//
	// Settlements created during weekends or on bank holidays will take place on the next business day.
	TransferFrequency *BalanceTransferFrequency `json:"transferFrequency,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	TransferThreshold *Amount `json:"transferThreshold,omitempty"`
	// The transfer reference set to be included in all the transfers for this balance.
	TransferReference *string `json:"transferReference,omitempty"`
	// The destination where the available amount will be automatically transferred to according to the configured
	// transfer frequency.
	TransferDestination *TransferDestination `json:"transferDestination,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	AvailableAmount *Amount `json:"availableAmount,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	PendingAmount *Amount `json:"pendingAmount,omitempty"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links *EntityBalanceLinks `json:"_links,omitempty"`
}

func (*EntityBalance) GetAvailableAmount 

func (e *EntityBalance) GetAvailableAmount() *Amount

func (*EntityBalance) GetCreatedAt 

func (e *EntityBalance) GetCreatedAt() *string

func (*EntityBalance) GetCurrency 

func (e *EntityBalance) GetCurrency() *Currencies

func (*EntityBalance) GetDescription 

func (e *EntityBalance) GetDescription() *string

func (*EntityBalance) GetID 

func (e *EntityBalance) GetID() *string
func (e *EntityBalance) GetLinks() *EntityBalanceLinks

func (*EntityBalance) GetMode 

func (e *EntityBalance) GetMode() *Mode

func (*EntityBalance) GetPendingAmount 

func (e *EntityBalance) GetPendingAmount() *Amount

func (*EntityBalance) GetResource 

func (e *EntityBalance) GetResource() *string

func (*EntityBalance) GetStatus 

func (e *EntityBalance) GetStatus() *BalanceStatus

func (*EntityBalance) GetTransferDestination 

func (e *EntityBalance) GetTransferDestination() *TransferDestination

func (*EntityBalance) GetTransferFrequency 

func (e *EntityBalance) GetTransferFrequency() *BalanceTransferFrequency

func (*EntityBalance) GetTransferReference 

func (e *EntityBalance) GetTransferReference() *string

func (*EntityBalance) GetTransferThreshold 

func (e *EntityBalance) GetTransferThreshold() *Amount
type EntityBalanceLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self *URLObj `json:"self,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation *URLObj `json:"documentation,omitempty"`
}

EntityBalanceLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.

func (*EntityBalanceLinks) GetDocumentation 

func (e *EntityBalanceLinks) GetDocumentation() *URLObj

func (*EntityBalanceLinks) GetSelf 

func (e *EntityBalanceLinks) GetSelf() *URLObj

type EntityBalanceReport 

type EntityBalanceReport struct {
	// Indicates the response contains a balance report object. Will always contain the string `balance-report` for this
	// endpoint.
	Resource  *string `json:"resource,omitempty"`
	BalanceID *string `json:"balanceId,omitempty"`
	// The time zone used for the from and until parameters. Currently only time zone `Europe/Amsterdam` is supported.
	TimeZone *string `json:"timeZone,omitempty"`
	// The start date of the report, in `YYYY-MM-DD` format. The from date is 'inclusive', and in Central European Time.
	// This means a report with for example `from=2024-01-01` will include movements of 2024-01-01 00:00:00 CET and
	// onwards.
	From *string `json:"from,omitempty"`
	// The end date of the report, in `YYYY-MM-DD` format. The until date is 'exclusive', and in Central European Time.
	// This means a report with for example `until=2024-02-01` will include movements up until 2024-01-31 23:59:59 CET.
	Until    *string                `json:"until,omitempty"`
	Grouping *BalanceReportGrouping `json:"grouping,omitempty"`
	// Totals are grouped according to the chosen grouping rule. The example response should give a good idea of what a
	// typical grouping looks like.
	//
	// If grouping `status-balances` is chosen, the main grouping is as follows:
	//
	// * `pendingBalance` containing an `open`, `pending`, `movedToAvailable`, and `close` sub-group
	// * `availableBalance` containing an `open`, `movedFromPending`, `immediatelyAvailable`, and `close` sub-group
	//
	// If grouping `transaction-categories` is chosen, the main grouping is as follows:
	//
	// * `open` and `close` groups, each containing a `pending` and `available` sub-group
	// * Transaction type groups such as `payments`, `refunds`, `chargebacks`, `capital`, `transfers`, `fee-prepayments`, `corrections`, `topups`
	// each containing a `pending`, `movedToAvailable`, and
	// `immediatelyAvailable` sub-group
	//
	// Each sub-group typically has:
	//
	// * An `amount` object containing the group's total amount
	// * A `count` integer if relevant (for example, counting the number of refunds)
	// * A `subtotals` array containing more sub-group objects if applicable
	Totals *Totals `json:"totals,omitempty"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links *EntityBalanceReportLinks `json:"_links,omitempty"`
}

func (*EntityBalanceReport) GetBalanceID 

func (e *EntityBalanceReport) GetBalanceID() *string

func (*EntityBalanceReport) GetFrom 

func (e *EntityBalanceReport) GetFrom() *string

func (*EntityBalanceReport) GetGrouping 

func (e *EntityBalanceReport) GetGrouping() *BalanceReportGrouping
func (e *EntityBalanceReport) GetLinks() *EntityBalanceReportLinks

func (*EntityBalanceReport) GetResource 

func (e *EntityBalanceReport) GetResource() *string

func (*EntityBalanceReport) GetTimeZone 

func (e *EntityBalanceReport) GetTimeZone() *string

func (*EntityBalanceReport) GetTotals 

func (e *EntityBalanceReport) GetTotals() *Totals

func (*EntityBalanceReport) GetUntil 

func (e *EntityBalanceReport) GetUntil() *string
type EntityBalanceReportLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self *URLObj `json:"self,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation *URLObj `json:"documentation,omitempty"`
}

EntityBalanceReportLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.

func (*EntityBalanceReportLinks) GetDocumentation 

func (e *EntityBalanceReportLinks) GetDocumentation() *URLObj

func (*EntityBalanceReportLinks) GetSelf 

func (e *EntityBalanceReportLinks) GetSelf() *URLObj

type EntityBalanceTransaction 

type EntityBalanceTransaction struct {
	// Indicates the response contains a balance transaction object. Will always contain the string `balance-transaction`
	// for this endpoint.
	Resource *string                 `json:"resource,omitempty"`
	ID       *string                 `json:"id,omitempty"`
	Type     *BalanceTransactionType `json:"type,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	ResultAmount *Amount `json:"resultAmount,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	InitialAmount *Amount `json:"initialAmount,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Deductions *AmountNullable `json:"deductions,omitempty"`
	// Depending on the type of the balance transaction, we will try to give more context about the specific event that
	// triggered it. For example, the context object for a payment transaction will look like
	// `{"paymentId": "tr_5B8cwPMGnU6qLbRvo7qEZo", "paymentDescription": "Description"}`.
	//
	// Below is a complete list of the context values that each type of transaction will have.
	//
	// * Type `payment`: `paymentId`, `paymentDescription`
	// * Type `capture`: `paymentId` `captureId`, `paymentDescription`, `captureDescription`
	// * Type `capture-commission`: `paymentId`, `paymentDescription`, `organizationId`
	// * Type `capture-rolling-reserve-release`: `paymentId`, `paymentDescription`, `captureId`, `captureDescription`
	// * Type `unauthorized-direct-debit`: `paymentId`, `paymentDescription`
	// * Type `failed-payment`: `paymentId`, `paymentDescription`
	// * Type `refund`: `paymentId` `refundId`, `paymentDescription`, `refundDescription`
	// * Type `refund-compensation`: `paymentId` `refundId`, `paymentDescription`, `refundDescription`
	// * Type `returned-refund`: `paymentId` `refundId`, `paymentDescription`, `refundDescription`
	// * Type `returned-refund-compensation`: `paymentId` `refundId`, `paymentDescription`, `refundDescription`
	// * Type `chargeback`: `paymentId` `chargebackId`, `paymentDescription`, `chargebackDescription`
	// * Type `chargeback-reversal`: `paymentId`, `chargebackId`, `paymentDescription`, `chargebackDescription`
	// * Type `chargeback-compensation`: `paymentId`, `chargebackId`, `paymentDescription`, `chargebackDescription`
	// * Type `reversed-chargeback-compensation`: `paymentId`, `chargebackId`, `paymentDescription`, `chargebackDescription`
	// * Type `outgoing-transfer`: `settlementId` `transferId`
	// * Type `canceled-outgoing-transfer`: `settlementId` `transferId`
	// * Type `returned-transfer`: `settlementId` `transferId`
	// * Type `invoice-compensation`: `invoiceId`
	// * Type `balance-correction`: none
	// * Type `application-fee`: `paymentId`, `paymentDescription`, `payingOwner`
	// * Type `split-payment`: `paymentId`, `paymentDescription`, `paymentOwner`
	// * Type `platform-payment-refund`: `paymentId` `refundId`, `paymentDescription`, `refundDescription`
	// * Type `returned-platform-payment-refund`: `paymentId` `refundId`, `paymentDescription`, `refundDescription`
	// * Type `platform-payment-chargeback`: `paymentId` `chargebackId`, `paymentDescription`, `chargebackDescription`
	// * Type `reversed-platform-payment-chargeback`: `paymentId` `chargebackId`, `paymentDescription`, `chargebackDescription`
	// * Type `payment-commission`: `paymentId`, `paymentDescription`, `organizationId`
	// * Type `reimbursement-fee`: `paymentId`, `paymentDescription`
	// * Type `failed-payment-fee`: `paymentId`, `paymentDescription`
	// * Type `payment-fee`: `paymentId`, `paymentDescription`
	// * Type `cash-advance-loan`: none
	// * Type `platform-connected-organizations-fee`: none
	// * Type `managed-fee`: `feeType`, `<name of the fee>Id`
	// * Type `returned-managed-fee`:  `feeType`, `<name of the fee>Id`
	// * Type `topup`: none
	// * Type `balance-reserve`: none
	// * Type `balance-reserve-return`: none
	// * Type `movement`: none
	// * Type `post-payment-split-payment`: `paymentId`
	// * Type `cash-collateral-issuance`: none
	// * Type `cash-collateral-release`: none
	Context *Context `json:"context,omitempty"`
	// The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	CreatedAt *string `json:"createdAt,omitempty"`
}

func (*EntityBalanceTransaction) GetContext 

func (e *EntityBalanceTransaction) GetContext() *Context

func (*EntityBalanceTransaction) GetCreatedAt 

func (e *EntityBalanceTransaction) GetCreatedAt() *string

func (*EntityBalanceTransaction) GetDeductions 

func (e *EntityBalanceTransaction) GetDeductions() *AmountNullable

func (*EntityBalanceTransaction) GetID 

func (e *EntityBalanceTransaction) GetID() *string

func (*EntityBalanceTransaction) GetInitialAmount 

func (e *EntityBalanceTransaction) GetInitialAmount() *Amount

func (*EntityBalanceTransaction) GetResource 

func (e *EntityBalanceTransaction) GetResource() *string

func (*EntityBalanceTransaction) GetResultAmount 

func (e *EntityBalanceTransaction) GetResultAmount() *Amount

func (*EntityBalanceTransaction) GetType 

func (e *EntityBalanceTransaction) GetType() *BalanceTransactionType

type EntityBalanceTransactionApplicationFee 

type EntityBalanceTransactionApplicationFee struct {
	PaymentID          *string `json:"paymentId,omitempty"`
	PaymentDescription *string `json:"paymentDescription,omitempty"`
	PayingOwner        *string `json:"payingOwner,omitempty"`
}

func (*EntityBalanceTransactionApplicationFee) GetPayingOwner 

func (e *EntityBalanceTransactionApplicationFee) GetPayingOwner() *string

func (*EntityBalanceTransactionApplicationFee) GetPaymentDescription 

func (e *EntityBalanceTransactionApplicationFee) GetPaymentDescription() *string

func (*EntityBalanceTransactionApplicationFee) GetPaymentID 

func (e *EntityBalanceTransactionApplicationFee) GetPaymentID() *string

type EntityBalanceTransfer added in v0.5.1 

type EntityBalanceTransfer struct {
	ID string `json:"id"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount Amount `json:"amount"`
	// A party involved in the balance transfer, either the sender or the receiver.
	Source EntityBalanceTransferParty `json:"source"`
	// A party involved in the balance transfer, either the sender or the receiver.
	Destination EntityBalanceTransferParty `json:"destination"`
	// The transfer description for initiating party.
	Description string `json:"description"`
	// The type of the transfer. Different fees may apply to different types of transfers.
	Category *BalanceTransferCategory `json:"category,omitempty"`
	// Whether to create the entity in test mode or live mode.
	//
	// Most API credentials are specifically created for either live mode or test mode, in which case this parameter can be
	// omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting
	// `testmode` to `true`.
	Testmode *bool `json:"testmode,omitempty"`
}

func (*EntityBalanceTransfer) GetAmount added in v0.5.1 

func (e *EntityBalanceTransfer) GetAmount() Amount

func (*EntityBalanceTransfer) GetCategory added in v0.5.1 

func (e *EntityBalanceTransfer) GetCategory() *BalanceTransferCategory

func (*EntityBalanceTransfer) GetDescription added in v0.5.1 

func (e *EntityBalanceTransfer) GetDescription() string

func (*EntityBalanceTransfer) GetDestination added in v0.5.1 

func (e *EntityBalanceTransfer) GetDestination() EntityBalanceTransferParty

func (*EntityBalanceTransfer) GetID added in v0.5.1 

func (e *EntityBalanceTransfer) GetID() string

func (*EntityBalanceTransfer) GetSource added in v0.5.1 

func (e *EntityBalanceTransfer) GetSource() EntityBalanceTransferParty

func (*EntityBalanceTransfer) GetTestmode added in v0.5.1 

func (e *EntityBalanceTransfer) GetTestmode() *bool

type EntityBalanceTransferParty added in v0.5.1 

type EntityBalanceTransferParty struct {
	// Defines the type of the party. At the moment, only `organization` is supported.
	Type BalanceTransferPartyType `json:"type"`
	ID   string                   `json:"id"`
	// The transfer description for the transfer party. This is the description that will appear in the financial reports of the party.
	Description string `json:"description"`
}

EntityBalanceTransferParty - A party involved in the balance transfer, either the sender or the receiver.

func (*EntityBalanceTransferParty) GetDescription added in v0.5.1 

func (e *EntityBalanceTransferParty) GetDescription() string

func (*EntityBalanceTransferParty) GetID added in v0.5.1 

func (e *EntityBalanceTransferParty) GetID() string

func (*EntityBalanceTransferParty) GetType added in v0.5.1 

func (e *EntityBalanceTransferParty) GetType() BalanceTransferPartyType

type EntityBalanceTransferPartyResponse added in v0.5.1 

type EntityBalanceTransferPartyResponse struct {
	// Defines the type of the party. At the moment, only `organization` is supported.
	Type BalanceTransferPartyTypeResponse `json:"type"`
	ID   string                           `json:"id"`
	// The transfer description for the transfer party. This is the description that will appear in the financial reports of the party.
	Description string `json:"description"`
}

EntityBalanceTransferPartyResponse - A party involved in the balance transfer, either the sender or the receiver.

func (*EntityBalanceTransferPartyResponse) GetDescription added in v0.5.1 

func (e *EntityBalanceTransferPartyResponse) GetDescription() string

func (*EntityBalanceTransferPartyResponse) GetID added in v0.5.1 

func (e *EntityBalanceTransferPartyResponse) GetID() string

func (*EntityBalanceTransferPartyResponse) GetType added in v0.5.1 

func (e *EntityBalanceTransferPartyResponse) GetType() BalanceTransferPartyTypeResponse

type EntityBalanceTransferResponse added in v0.5.1 

type EntityBalanceTransferResponse struct {
	// Indicates the response contains a balance transfer object. Will always contain the string `connect-balance-transfer` for this endpoint.
	Resource string `json:"resource"`
	ID       string `json:"id"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount Amount `json:"amount"`
	// A party involved in the balance transfer, either the sender or the receiver.
	Source EntityBalanceTransferPartyResponse `json:"source"`
	// A party involved in the balance transfer, either the sender or the receiver.
	Destination EntityBalanceTransferPartyResponse `json:"destination"`
	// The transfer description for initiating party.
	Description string `json:"description"`
	// The status of the transfer.
	Status BalanceTransferStatus `json:"status"`
	// The reason for the current status of the transfer, if applicable.
	StatusReason EntityBalanceTransferResponseStatusReason `json:"statusReason"`
	// The type of the transfer. Different fees may apply to different types of transfers.
	Category *BalanceTransferCategoryResponse `json:"category,omitempty"`
	// The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	CreatedAt string `json:"createdAt"`
	// The date and time when the transfer was completed, in ISO 8601 format. This parameter is omitted if the transfer is
	// not executed (yet).
	ExecutedAt *string `json:"executedAt,omitempty"`
	// Whether this entity was created in live mode or in test mode.
	Mode Mode `json:"mode"`
}

func (*EntityBalanceTransferResponse) GetAmount added in v0.5.1 

func (e *EntityBalanceTransferResponse) GetAmount() Amount

func (*EntityBalanceTransferResponse) GetCategory added in v0.5.1 

func (e *EntityBalanceTransferResponse) GetCategory() *BalanceTransferCategoryResponse

func (*EntityBalanceTransferResponse) GetCreatedAt added in v0.5.1 

func (e *EntityBalanceTransferResponse) GetCreatedAt() string

func (*EntityBalanceTransferResponse) GetDescription added in v0.5.1 

func (e *EntityBalanceTransferResponse) GetDescription() string

func (*EntityBalanceTransferResponse) GetDestination added in v0.5.1 

func (e *EntityBalanceTransferResponse) GetDestination() EntityBalanceTransferPartyResponse

func (*EntityBalanceTransferResponse) GetExecutedAt added in v0.5.1 

func (e *EntityBalanceTransferResponse) GetExecutedAt() *string

func (*EntityBalanceTransferResponse) GetID added in v0.5.1 

func (e *EntityBalanceTransferResponse) GetID() string

func (*EntityBalanceTransferResponse) GetMode added in v0.5.1 

func (e *EntityBalanceTransferResponse) GetMode() Mode

func (*EntityBalanceTransferResponse) GetResource added in v0.5.1 

func (e *EntityBalanceTransferResponse) GetResource() string

func (*EntityBalanceTransferResponse) GetSource added in v0.5.1 

func (e *EntityBalanceTransferResponse) GetSource() EntityBalanceTransferPartyResponse

func (*EntityBalanceTransferResponse) GetStatus added in v0.5.1 

func (e *EntityBalanceTransferResponse) GetStatus() BalanceTransferStatus

func (*EntityBalanceTransferResponse) GetStatusReason added in v0.5.1 

func (e *EntityBalanceTransferResponse) GetStatusReason() EntityBalanceTransferResponseStatusReason

type EntityBalanceTransferResponseStatusReason added in v0.5.1 

type EntityBalanceTransferResponseStatusReason struct {
	// A machine-readable code that indicates the reason for the transfer's status.
	Code BalanceTransferStatusReasonResponse `json:"code"`
	// A description of the status reason, localized according to the transfer.
	Message string `json:"message"`
}

EntityBalanceTransferResponseStatusReason - The reason for the current status of the transfer, if applicable.

func (*EntityBalanceTransferResponseStatusReason) GetCode added in v0.5.1 

func (e *EntityBalanceTransferResponseStatusReason) GetCode() BalanceTransferStatusReasonResponse

func (*EntityBalanceTransferResponseStatusReason) GetMessage added in v0.5.1 

func (e *EntityBalanceTransferResponseStatusReason) GetMessage() string

type EntityCapability 

type EntityCapability struct {
	// Always the word `capability` for this resource type.
	Resource *string `json:"resource,omitempty"`
	// A unique name for this capability like `payments` / `settlements`.
	Name         *string                       `json:"name,omitempty"`
	Status       *CapabilityStatus             `json:"status,omitempty"`
	StatusReason *CapabilityStatusReason       `json:"statusReason,omitempty"`
	Requirements []EntityCapabilityRequirement `json:"requirements,omitempty"`
}

func (*EntityCapability) GetName 

func (e *EntityCapability) GetName() *string

func (*EntityCapability) GetRequirements 

func (e *EntityCapability) GetRequirements() []EntityCapabilityRequirement

func (*EntityCapability) GetResource 

func (e *EntityCapability) GetResource() *string

func (*EntityCapability) GetStatus 

func (e *EntityCapability) GetStatus() *CapabilityStatus

func (*EntityCapability) GetStatusReason 

func (e *EntityCapability) GetStatusReason() *CapabilityStatusReason

type EntityCapabilityRequirement 

type EntityCapabilityRequirement struct {
	// The name of this requirement, referring to the task to be fulfilled by the organization
	// to enable or re-enable the capability. The name is unique among other requirements
	// of the same capability.
	ID *string `json:"id,omitempty"`
	// The status of the requirement depends on its due date.
	// If no due date is given, the status will be `requested`.
	Status *CapabilityRequirementStatus `json:"status,omitempty"`
	// Due date until the requirement must be fulfilled, if any. The date is shown in ISO-8601 format.
	DueDate *string                           `json:"dueDate,omitempty"`
	Links   *EntityCapabilityRequirementLinks `json:"_links,omitempty"`
}

func (*EntityCapabilityRequirement) GetDueDate 

func (e *EntityCapabilityRequirement) GetDueDate() *string

func (*EntityCapabilityRequirement) GetID 

func (e *EntityCapabilityRequirement) GetID() *string
func (e *EntityCapabilityRequirement) GetLinks() *EntityCapabilityRequirementLinks

func (*EntityCapabilityRequirement) GetStatus 

func (e *EntityCapabilityRequirement) GetStatus() *CapabilityRequirementStatus
type EntityCapabilityRequirementLinks struct {
	// If known, a deep link to the Mollie dashboard of the client, where the requirement can be fulfilled.
	// For example, where necessary documents are to be uploaded.
	Dashboard *Dashboard `json:"dashboard,omitempty"`
}

func (*EntityCapabilityRequirementLinks) GetDashboard 

func (e *EntityCapabilityRequirementLinks) GetDashboard() *Dashboard

type EntityCapture 

type EntityCapture struct {
	ID *string `json:"id,omitempty"`
	// The description of the capture.
	Description *string `json:"description,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount *AmountNullable `json:"amount,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	SettlementAmount *AmountNullable `json:"settlementAmount,omitempty"`
	// The capture's status.
	Status *CaptureStatus `json:"status,omitempty"`
	// Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever
	// you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
	Metadata     *Metadata `json:"metadata,omitempty"`
	PaymentID    *string   `json:"paymentId,omitempty"`
	ShipmentID   *string   `json:"shipmentId,omitempty"`
	SettlementID *string   `json:"settlementId,omitempty"`
}

func (*EntityCapture) GetAmount 

func (e *EntityCapture) GetAmount() *AmountNullable

func (*EntityCapture) GetDescription 

func (e *EntityCapture) GetDescription() *string

func (*EntityCapture) GetID 

func (e *EntityCapture) GetID() *string

func (*EntityCapture) GetMetadata 

func (e *EntityCapture) GetMetadata() *Metadata

func (*EntityCapture) GetPaymentID 

func (e *EntityCapture) GetPaymentID() *string

func (*EntityCapture) GetSettlementAmount 

func (e *EntityCapture) GetSettlementAmount() *AmountNullable

func (*EntityCapture) GetSettlementID 

func (e *EntityCapture) GetSettlementID() *string

func (*EntityCapture) GetShipmentID 

func (e *EntityCapture) GetShipmentID() *string

func (*EntityCapture) GetStatus 

func (e *EntityCapture) GetStatus() *CaptureStatus

type EntityChargeback 

type EntityChargeback struct {
	// Indicates the response contains a chargeback object. Will always contain the string `chargeback` for this
	// endpoint.
	Resource string `json:"resource"`
	ID       string `json:"id"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount Amount `json:"amount"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	SettlementAmount *AmountNullable `json:"settlementAmount,omitempty"`
	// Reason for the chargeback as given by the bank. Only available for chargebacks of SEPA Direct Debit payments.
	Reason       *Reason `json:"reason,omitempty"`
	PaymentID    string  `json:"paymentId"`
	SettlementID *string `json:"settlementId,omitempty"`
	// The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	CreatedAt string `json:"createdAt"`
	// The date and time the chargeback was reversed if applicable, in
	// [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	ReversedAt *string `json:"reversedAt,omitempty"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links EntityChargebackLinks `json:"_links"`
}

func (*EntityChargeback) GetAmount 

func (e *EntityChargeback) GetAmount() Amount

func (*EntityChargeback) GetCreatedAt 

func (e *EntityChargeback) GetCreatedAt() string

func (*EntityChargeback) GetID 

func (e *EntityChargeback) GetID() string
func (e *EntityChargeback) GetLinks() EntityChargebackLinks

func (*EntityChargeback) GetPaymentID 

func (e *EntityChargeback) GetPaymentID() string

func (*EntityChargeback) GetReason 

func (e *EntityChargeback) GetReason() *Reason

func (*EntityChargeback) GetResource 

func (e *EntityChargeback) GetResource() string

func (*EntityChargeback) GetReversedAt 

func (e *EntityChargeback) GetReversedAt() *string

func (*EntityChargeback) GetSettlementAmount 

func (e *EntityChargeback) GetSettlementAmount() *AmountNullable

func (*EntityChargeback) GetSettlementID 

func (e *EntityChargeback) GetSettlementID() *string
type EntityChargebackLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self URLObj `json:"self"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Payment URLObj `json:"payment"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Settlement *URLNullable `json:"settlement,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation URLObj `json:"documentation"`
}

EntityChargebackLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.

func (*EntityChargebackLinks) GetDocumentation 

func (e *EntityChargebackLinks) GetDocumentation() URLObj

func (*EntityChargebackLinks) GetPayment 

func (e *EntityChargebackLinks) GetPayment() URLObj

func (*EntityChargebackLinks) GetSelf 

func (e *EntityChargebackLinks) GetSelf() URLObj

func (*EntityChargebackLinks) GetSettlement 

func (e *EntityChargebackLinks) GetSettlement() *URLNullable
type EntityClientLink struct {
	// Personal data of your customer.
	Owner *Owner `json:"owner,omitempty"`
	// Name of the organization.
	Name *string `json:"name,omitempty"`
	// Address of the organization.
	Address *EntityClientLinkAddress `json:"address,omitempty"`
	// The registration number of the organization at their local chamber of commerce.
	RegistrationNumber *string `json:"registrationNumber,omitempty"`
	// The VAT number of the organization, if based in the European Union. VAT numbers are verified against the
	// international registry *VIES*.
	VatNumber *string `json:"vatNumber,omitempty"`
}

func (*EntityClientLink) GetAddress 

func (e *EntityClientLink) GetAddress() *EntityClientLinkAddress

func (*EntityClientLink) GetName 

func (e *EntityClientLink) GetName() *string

func (*EntityClientLink) GetOwner 

func (e *EntityClientLink) GetOwner() *Owner

func (*EntityClientLink) GetRegistrationNumber 

func (e *EntityClientLink) GetRegistrationNumber() *string

func (*EntityClientLink) GetVatNumber 

func (e *EntityClientLink) GetVatNumber() *string

type EntityClientLinkAddress 

type EntityClientLinkAddress struct {
	// The street name and house number of the organization.
	StreetAndNumber *string `json:"streetAndNumber,omitempty"`
	// The postal code of the organization. Required if a street address is provided and if the country has a postal
	// code system.
	PostalCode *string `json:"postalCode,omitempty"`
	// The city of the organization. Required if a street address is provided.
	City *string `json:"city,omitempty"`
	// The country of the address in
	// [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
	Country string `json:"country"`
}

EntityClientLinkAddress - Address of the organization.

func (*EntityClientLinkAddress) GetCity 

func (e *EntityClientLinkAddress) GetCity() *string

func (*EntityClientLinkAddress) GetCountry 

func (e *EntityClientLinkAddress) GetCountry() string

func (*EntityClientLinkAddress) GetPostalCode 

func (e *EntityClientLinkAddress) GetPostalCode() *string

func (*EntityClientLinkAddress) GetStreetAndNumber 

func (e *EntityClientLinkAddress) GetStreetAndNumber() *string

type EntityClientLinkResponse 

type EntityClientLinkResponse struct {
	// Indicates the response contains a client link object. Will always contain the string `client-link` for this
	// endpoint.
	Resource *string `json:"resource,omitempty"`
	// The identifier uniquely referring to this client link. Example: `cl_vZCnNQsV2UtfXxYifWKWH`.
	ID *string `json:"id,omitempty"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links *EntityClientLinkResponseLinks `json:"_links,omitempty"`
}

func (*EntityClientLinkResponse) GetID 

func (e *EntityClientLinkResponse) GetID() *string
func (e *EntityClientLinkResponse) GetLinks() *EntityClientLinkResponseLinks

func (*EntityClientLinkResponse) GetResource 

func (e *EntityClientLinkResponse) GetResource() *string
type EntityClientLinkResponseLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self *URLObj `json:"self,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	ClientLink *URLObj `json:"clientLink,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation *URLObj `json:"documentation,omitempty"`
}

EntityClientLinkResponseLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field. 

func (e *EntityClientLinkResponseLinks) GetClientLink() *URLObj

func (*EntityClientLinkResponseLinks) GetDocumentation 

func (e *EntityClientLinkResponseLinks) GetDocumentation() *URLObj

func (*EntityClientLinkResponseLinks) GetSelf 

func (e *EntityClientLinkResponseLinks) GetSelf() *URLObj

type EntityCustomer 

type EntityCustomer struct {
	ID *string `json:"id,omitempty"`
	// The full name of the customer.
	Name *string `json:"name,omitempty"`
	// The email address of the customer.
	Email *string `json:"email,omitempty"`
	// Allows you to preset the language to be used.
	Locale *LocaleResponse `json:"locale,omitempty"`
	// Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever
	// you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
	Metadata *Metadata `json:"metadata,omitempty"`
	// Whether to create the entity in test mode or live mode.
	//
	// Most API credentials are specifically created for either live mode or test mode, in which case this parameter can be
	// omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting
	// `testmode` to `true`.
	Testmode *bool `json:"testmode,omitempty"`
}

func (*EntityCustomer) GetEmail 

func (e *EntityCustomer) GetEmail() *string

func (*EntityCustomer) GetID 

func (e *EntityCustomer) GetID() *string

func (*EntityCustomer) GetLocale 

func (e *EntityCustomer) GetLocale() *LocaleResponse

func (*EntityCustomer) GetMetadata 

func (e *EntityCustomer) GetMetadata() *Metadata

func (*EntityCustomer) GetName 

func (e *EntityCustomer) GetName() *string

func (*EntityCustomer) GetTestmode 

func (e *EntityCustomer) GetTestmode() *bool

type EntityEvent 

type EntityEvent struct {
	Resource string `json:"resource"`
	Type     int64  `json:"type"`
	// The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	CreatedAt string `json:"createdAt"`
	Message   string `json:"message"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links *EntityEventLinks `json:"_links,omitempty"`
}

func (*EntityEvent) GetCreatedAt 

func (e *EntityEvent) GetCreatedAt() string
func (e *EntityEvent) GetLinks() *EntityEventLinks

func (*EntityEvent) GetMessage 

func (e *EntityEvent) GetMessage() string

func (*EntityEvent) GetResource 

func (e *EntityEvent) GetResource() string

func (*EntityEvent) GetType 

func (e *EntityEvent) GetType() int64
type EntityEventLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	URL *URLObj `json:"url,omitempty"`
}

EntityEventLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.

func (*EntityEventLinks) GetURL 

func (e *EntityEventLinks) GetURL() *URLObj

type EntityInvoice 

type EntityInvoice struct {
	// Indicates that the response contains an invoice object.
	// Will always contain the string `invoice` for this endpoint.
	Resource *string `json:"resource,omitempty"`
	// The identifier uniquely referring to this invoice. Example: `inv_FrvewDA3Pr`.
	ID *string `json:"id,omitempty"`
	// The reference number of the invoice. An example value would be: `2024.10000`.
	Reference *string `json:"reference,omitempty"`
	// The VAT number to which the invoice was issued to, if applicable.
	VatNumber *string `json:"vatNumber,omitempty"`
	// Status of the invoice.
	Status *InvoiceStatus `json:"status,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	NetAmount *Amount `json:"netAmount,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	VatAmount *Amount `json:"vatAmount,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	GrossAmount *Amount `json:"grossAmount,omitempty"`
	// The collection of products which make up the invoice.
	Lines []EntityInvoiceLine `json:"lines,omitempty"`
	// The invoice date in `YYYY-MM-DD` format.
	IssuedAt *string `json:"issuedAt,omitempty"`
	// The date on which the invoice was paid, if applicable, in `YYYY-MM-DD` format.
	PaidAt *string `json:"paidAt,omitempty"`
	// The date on which the invoice is due, if applicable, in `YYYY-MM-DD` format.
	DueAt *string `json:"dueAt,omitempty"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links *EntityInvoiceLinks `json:"_links,omitempty"`
}

func (*EntityInvoice) GetDueAt 

func (e *EntityInvoice) GetDueAt() *string

func (*EntityInvoice) GetGrossAmount 

func (e *EntityInvoice) GetGrossAmount() *Amount

func (*EntityInvoice) GetID 

func (e *EntityInvoice) GetID() *string

func (*EntityInvoice) GetIssuedAt 

func (e *EntityInvoice) GetIssuedAt() *string

func (*EntityInvoice) GetLines 

func (e *EntityInvoice) GetLines() []EntityInvoiceLine
func (e *EntityInvoice) GetLinks() *EntityInvoiceLinks

func (*EntityInvoice) GetNetAmount 

func (e *EntityInvoice) GetNetAmount() *Amount

func (*EntityInvoice) GetPaidAt 

func (e *EntityInvoice) GetPaidAt() *string

func (*EntityInvoice) GetReference 

func (e *EntityInvoice) GetReference() *string

func (*EntityInvoice) GetResource 

func (e *EntityInvoice) GetResource() *string

func (*EntityInvoice) GetStatus 

func (e *EntityInvoice) GetStatus() *InvoiceStatus

func (*EntityInvoice) GetVatAmount 

func (e *EntityInvoice) GetVatAmount() *Amount

func (*EntityInvoice) GetVatNumber 

func (e *EntityInvoice) GetVatNumber() *string

type EntityInvoiceLine 

type EntityInvoiceLine struct {
	// The administrative period in `YYYY-MM` on which the line should be booked.
	Period *string `json:"period,omitempty"`
	// Description of the product.
	Description *string `json:"description,omitempty"`
	// Number of products invoiced. For example, the number of payments.
	Count *int64 `json:"count,omitempty"`
	// VAT percentage rate that applies to this product.
	VatPercentage *int64 `json:"vatPercentage,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount *Amount `json:"amount,omitempty"`
}

func (*EntityInvoiceLine) GetAmount 

func (e *EntityInvoiceLine) GetAmount() *Amount

func (*EntityInvoiceLine) GetCount 

func (e *EntityInvoiceLine) GetCount() *int64

func (*EntityInvoiceLine) GetDescription 

func (e *EntityInvoiceLine) GetDescription() *string

func (*EntityInvoiceLine) GetPeriod 

func (e *EntityInvoiceLine) GetPeriod() *string

func (*EntityInvoiceLine) GetVatPercentage 

func (e *EntityInvoiceLine) GetVatPercentage() *int64
type EntityInvoiceLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self *URLObj `json:"self,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Pdf *URLObj `json:"pdf,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation *URLObj `json:"documentation,omitempty"`
}

EntityInvoiceLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.

func (*EntityInvoiceLinks) GetDocumentation 

func (e *EntityInvoiceLinks) GetDocumentation() *URLObj

func (*EntityInvoiceLinks) GetPdf 

func (e *EntityInvoiceLinks) GetPdf() *URLObj

func (*EntityInvoiceLinks) GetSelf 

func (e *EntityInvoiceLinks) GetSelf() *URLObj

type EntityMandate 

type EntityMandate struct {
	ID *string `json:"id,omitempty"`
	// Payment method of the mandate.
	//
	// SEPA Direct Debit and PayPal mandates can be created directly.
	Method *MandateMethod `json:"method,omitempty"`
	// The customer's name.
	ConsumerName *string `json:"consumerName,omitempty"`
	// The customer's IBAN. Required for SEPA Direct Debit mandates.
	ConsumerAccount *string `json:"consumerAccount,omitempty"`
	// The BIC of the customer's bank.
	ConsumerBic *string `json:"consumerBic,omitempty"`
	// The customer's email address. Required for PayPal mandates.
	ConsumerEmail *string `json:"consumerEmail,omitempty"`
	// The date when the mandate was signed in `YYYY-MM-DD` format.
	SignatureDate *string `json:"signatureDate,omitempty"`
	// A custom mandate reference. For SEPA Direct Debit, it is vital to provide a unique reference. Some banks will
	// decline Direct Debit payments if the mandate reference is not unique.
	MandateReference *string `json:"mandateReference,omitempty"`
	// The billing agreement ID given by PayPal. For example: `B-12A34567B8901234CD`. Required for PayPal mandates.
	// Must provide either this field or `payPalVaultId`, but not both.
	PaypalBillingAgreementID *string `json:"paypalBillingAgreementId,omitempty"`
	// The Vault ID given by PayPal. For example: `8kk8451t`. Required for PayPal mandates.
	// Must provide either this field or `paypalBillingAgreementId`, but not both.
	PayPalVaultID *string `json:"payPalVaultId,omitempty"`
	// The status of the mandate. A status can be `pending` for mandates when the first payment is not yet finalized, or
	// when we did not received the IBAN yet from the first payment.
	Status     *MandateStatus `json:"status,omitempty"`
	CustomerID *string        `json:"customerId,omitempty"`
	// Whether to create the entity in test mode or live mode.
	//
	// Most API credentials are specifically created for either live mode or test mode, in which case this parameter can be
	// omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting
	// `testmode` to `true`.
	Testmode *bool `json:"testmode,omitempty"`
}

func (*EntityMandate) GetConsumerAccount 

func (e *EntityMandate) GetConsumerAccount() *string

func (*EntityMandate) GetConsumerBic 

func (e *EntityMandate) GetConsumerBic() *string

func (*EntityMandate) GetConsumerEmail 

func (e *EntityMandate) GetConsumerEmail() *string

func (*EntityMandate) GetConsumerName 

func (e *EntityMandate) GetConsumerName() *string

func (*EntityMandate) GetCustomerID 

func (e *EntityMandate) GetCustomerID() *string

func (*EntityMandate) GetID 

func (e *EntityMandate) GetID() *string

func (*EntityMandate) GetMandateReference 

func (e *EntityMandate) GetMandateReference() *string

func (*EntityMandate) GetMethod 

func (e *EntityMandate) GetMethod() *MandateMethod

func (*EntityMandate) GetPayPalVaultID 

func (e *EntityMandate) GetPayPalVaultID() *string

func (*EntityMandate) GetPaypalBillingAgreementID 

func (e *EntityMandate) GetPaypalBillingAgreementID() *string

func (*EntityMandate) GetSignatureDate 

func (e *EntityMandate) GetSignatureDate() *string

func (*EntityMandate) GetStatus 

func (e *EntityMandate) GetStatus() *MandateStatus

func (*EntityMandate) GetTestmode 

func (e *EntityMandate) GetTestmode() *bool

type EntityMethod 

type EntityMethod struct {
	// Indicates the response contains a payment method object. Will always contain the string `method` for this
	// endpoint.
	Resource string `json:"resource"`
	// Normally, a payment method screen is shown. However, when using this parameter, you can choose a specific payment
	// method and your customer will skip the selection screen and is sent directly to the chosen payment method. The
	// parameter enables you to fully integrate the payment method selection into your website.
	//
	// You can also specify the methods in an array. By doing so we will still show the payment method selection screen
	// but will only show the methods specified in the array. For example, you can use this functionality to only show
	// payment methods from a specific country to your customer `['bancontact', 'belfius']`.
	ID *MethodResponse `json:"id"`
	// The full name of the payment method.
	//
	// If a `locale` parameter is provided, the name is translated to the given locale if possible.
	Description string `json:"description"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	MinimumAmount Amount `json:"minimumAmount"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	MaximumAmount *AmountNullable `json:"maximumAmount"`
	// URLs of images representing the payment method.
	Image EntityMethodImage `json:"image"`
	// The payment method's activation status for this profile.
	Status MethodStatus `json:"status"`
	// **Optional include.** Array of objects for each 'issuer' that is available for this payment method. Only relevant
	// for iDEAL, KBC/CBC, gift cards, and vouchers.
	Issuers []EntityMethodIssuer `json:"issuers,omitempty"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links EntityMethodLinks `json:"_links"`
}

func (*EntityMethod) GetDescription 

func (e *EntityMethod) GetDescription() string

func (*EntityMethod) GetID 

func (e *EntityMethod) GetID() *MethodResponse

func (*EntityMethod) GetImage 

func (e *EntityMethod) GetImage() EntityMethodImage

func (*EntityMethod) GetIssuers 

func (e *EntityMethod) GetIssuers() []EntityMethodIssuer
func (e *EntityMethod) GetLinks() EntityMethodLinks

func (*EntityMethod) GetMaximumAmount 

func (e *EntityMethod) GetMaximumAmount() *AmountNullable

func (*EntityMethod) GetMinimumAmount 

func (e *EntityMethod) GetMinimumAmount() Amount

func (*EntityMethod) GetResource 

func (e *EntityMethod) GetResource() string

func (*EntityMethod) GetStatus 

func (e *EntityMethod) GetStatus() MethodStatus

type EntityMethodAll 

type EntityMethodAll struct {
	// Indicates the response contains a payment method object. Will always contain the string `method` for this
	// endpoint.
	Resource string `json:"resource"`
	// Normally, a payment method screen is shown. However, when using this parameter, you can choose a specific payment
	// method and your customer will skip the selection screen and is sent directly to the chosen payment method. The
	// parameter enables you to fully integrate the payment method selection into your website.
	//
	// You can also specify the methods in an array. By doing so we will still show the payment method selection screen
	// but will only show the methods specified in the array. For example, you can use this functionality to only show
	// payment methods from a specific country to your customer `['bancontact', 'belfius']`.
	ID *MethodResponse `json:"id"`
	// The full name of the payment method.
	//
	// If a `locale` parameter is provided, the name is translated to the given locale if possible.
	Description string `json:"description"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	MinimumAmount Amount `json:"minimumAmount"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	MaximumAmount *AmountNullable `json:"maximumAmount"`
	// URLs of images representing the payment method.
	Image EntityMethodAllImage `json:"image"`
	// The payment method's activation status for this profile.
	Status MethodStatus `json:"status"`
	// **Optional include.** Array of objects for each 'issuer' that is available for this payment method. Only relevant
	// for iDEAL, KBC/CBC, gift cards, and vouchers.
	Issuers []EntityMethodAllIssuer `json:"issuers,omitempty"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links EntityMethodAllLinks `json:"_links"`
	// **Optional include.** Array of objects describing the pricing configuration applicable for this payment method on
	// your account.
	Pricing []Pricing `json:"pricing,omitempty"`
}

func (*EntityMethodAll) GetDescription 

func (e *EntityMethodAll) GetDescription() string

func (*EntityMethodAll) GetID 

func (e *EntityMethodAll) GetID() *MethodResponse

func (*EntityMethodAll) GetImage 

func (e *EntityMethodAll) GetImage() EntityMethodAllImage

func (*EntityMethodAll) GetIssuers 

func (e *EntityMethodAll) GetIssuers() []EntityMethodAllIssuer
func (e *EntityMethodAll) GetLinks() EntityMethodAllLinks

func (*EntityMethodAll) GetMaximumAmount 

func (e *EntityMethodAll) GetMaximumAmount() *AmountNullable

func (*EntityMethodAll) GetMinimumAmount 

func (e *EntityMethodAll) GetMinimumAmount() Amount

func (*EntityMethodAll) GetPricing 

func (e *EntityMethodAll) GetPricing() []Pricing

func (*EntityMethodAll) GetResource 

func (e *EntityMethodAll) GetResource() string

func (*EntityMethodAll) GetStatus 

func (e *EntityMethodAll) GetStatus() MethodStatus

type EntityMethodAllImage 

type EntityMethodAllImage struct {
	// The URL pointing to an icon of 32 by 24 pixels.
	Size1x string `json:"size1x"`
	// The URL pointing to an icon of 64 by 48 pixels.
	Size2x string `json:"size2x"`
	// The URL pointing to a vector version of the icon. Usage of this format is preferred, since the icon can
	// scale to any desired size without compromising visual quality.
	Svg string `json:"svg"`
}

EntityMethodAllImage - URLs of images representing the payment method.

func (*EntityMethodAllImage) GetSize1x 

func (e *EntityMethodAllImage) GetSize1x() string

func (*EntityMethodAllImage) GetSize2x 

func (e *EntityMethodAllImage) GetSize2x() string

func (*EntityMethodAllImage) GetSvg 

func (e *EntityMethodAllImage) GetSvg() string

type EntityMethodAllIssuer 

type EntityMethodAllIssuer struct {
	Resource string `json:"resource"`
	ID       string `json:"id"`
	// The full name of the issuer.
	Name string `json:"name"`
	// URLs of images representing the issuer.
	// required:
	//   - size1x
	//   - size2x
	//   - svg
	Image EntityMethodAllIssuerImage `json:"image"`
}

func (*EntityMethodAllIssuer) GetID 

func (e *EntityMethodAllIssuer) GetID() string

func (*EntityMethodAllIssuer) GetImage 

func (e *EntityMethodAllIssuer) GetImage() EntityMethodAllIssuerImage

func (*EntityMethodAllIssuer) GetName 

func (e *EntityMethodAllIssuer) GetName() string

func (*EntityMethodAllIssuer) GetResource 

func (e *EntityMethodAllIssuer) GetResource() string

type EntityMethodAllIssuerImage 

type EntityMethodAllIssuerImage struct {
	// The URL pointing to an icon of 32 by 24 pixels.
	Size1x *string `json:"size1x,omitempty"`
	// The URL pointing to an icon of 64 by 48 pixels.
	Size2x *string `json:"size2x,omitempty"`
	// The URL pointing to a vector version of the icon. Usage of this format is preferred, since the icon can
	// scale to any desired size without compromising visual quality.
	Svg *string `json:"svg,omitempty"`
}

EntityMethodAllIssuerImage - URLs of images representing the issuer. required:

  • size1x
  • size2x
  • svg

func (*EntityMethodAllIssuerImage) GetSize1x 

func (e *EntityMethodAllIssuerImage) GetSize1x() *string

func (*EntityMethodAllIssuerImage) GetSize2x 

func (e *EntityMethodAllIssuerImage) GetSize2x() *string

func (*EntityMethodAllIssuerImage) GetSvg 

func (e *EntityMethodAllIssuerImage) GetSvg() *string
type EntityMethodAllLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self URLObj `json:"self"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation *URLObj `json:"documentation,omitempty"`
}

EntityMethodAllLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.

func (*EntityMethodAllLinks) GetDocumentation 

func (e *EntityMethodAllLinks) GetDocumentation() *URLObj

func (*EntityMethodAllLinks) GetSelf 

func (e *EntityMethodAllLinks) GetSelf() URLObj

type EntityMethodImage 

type EntityMethodImage struct {
	// The URL pointing to an icon of 32 by 24 pixels.
	Size1x string `json:"size1x"`
	// The URL pointing to an icon of 64 by 48 pixels.
	Size2x string `json:"size2x"`
	// The URL pointing to a vector version of the icon. Usage of this format is preferred, since the icon can
	// scale to any desired size without compromising visual quality.
	Svg string `json:"svg"`
}

EntityMethodImage - URLs of images representing the payment method.

func (*EntityMethodImage) GetSize1x 

func (e *EntityMethodImage) GetSize1x() string

func (*EntityMethodImage) GetSize2x 

func (e *EntityMethodImage) GetSize2x() string

func (*EntityMethodImage) GetSvg 

func (e *EntityMethodImage) GetSvg() string

type EntityMethodIssuer 

type EntityMethodIssuer struct {
	Resource string `json:"resource"`
	ID       string `json:"id"`
	// The full name of the issuer.
	Name string `json:"name"`
	// URLs of images representing the issuer.
	// required:
	//   - size1x
	//   - size2x
	//   - svg
	Image EntityMethodIssuerImage `json:"image"`
}

func (*EntityMethodIssuer) GetID 

func (e *EntityMethodIssuer) GetID() string

func (*EntityMethodIssuer) GetImage 

func (e *EntityMethodIssuer) GetImage() EntityMethodIssuerImage

func (*EntityMethodIssuer) GetName 

func (e *EntityMethodIssuer) GetName() string

func (*EntityMethodIssuer) GetResource 

func (e *EntityMethodIssuer) GetResource() string

type EntityMethodIssuerImage 

type EntityMethodIssuerImage struct {
	// The URL pointing to an icon of 32 by 24 pixels.
	Size1x *string `json:"size1x,omitempty"`
	// The URL pointing to an icon of 64 by 48 pixels.
	Size2x *string `json:"size2x,omitempty"`
	// The URL pointing to a vector version of the icon. Usage of this format is preferred, since the icon can
	// scale to any desired size without compromising visual quality.
	Svg *string `json:"svg,omitempty"`
}

EntityMethodIssuerImage - URLs of images representing the issuer. required:

  • size1x
  • size2x
  • svg

func (*EntityMethodIssuerImage) GetSize1x 

func (e *EntityMethodIssuerImage) GetSize1x() *string

func (*EntityMethodIssuerImage) GetSize2x 

func (e *EntityMethodIssuerImage) GetSize2x() *string

func (*EntityMethodIssuerImage) GetSvg 

func (e *EntityMethodIssuerImage) GetSvg() *string
type EntityMethodLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self URLObj `json:"self"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation *URLObj `json:"documentation,omitempty"`
}

EntityMethodLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.

func (*EntityMethodLinks) GetDocumentation 

func (e *EntityMethodLinks) GetDocumentation() *URLObj

func (*EntityMethodLinks) GetSelf 

func (e *EntityMethodLinks) GetSelf() URLObj

type EntityOnboardingStatus 

type EntityOnboardingStatus struct {
	// Indicates the response contains an onboarding status object. Will always contain the string `onboarding` for this
	// resource type.
	Resource *string `json:"resource,omitempty"`
	// The name of the organization.
	Name *string `json:"name,omitempty"`
	// The current status of the organization's onboarding process.
	Status *OnboardingStatus `json:"status,omitempty"`
	// Whether the organization can receive payments.
	CanReceivePayments *bool `json:"canReceivePayments,omitempty"`
	// Whether the organization can receive settlements to their external bank account.
	CanReceiveSettlements *bool `json:"canReceiveSettlements,omitempty"`
	// The sign up date time of the organization in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	SignedUpAt *string `json:"signedUpAt,omitempty"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links *EntityOnboardingStatusLinks `json:"_links,omitempty"`
}

func (*EntityOnboardingStatus) GetCanReceivePayments 

func (e *EntityOnboardingStatus) GetCanReceivePayments() *bool

func (*EntityOnboardingStatus) GetCanReceiveSettlements 

func (e *EntityOnboardingStatus) GetCanReceiveSettlements() *bool
func (e *EntityOnboardingStatus) GetLinks() *EntityOnboardingStatusLinks

func (*EntityOnboardingStatus) GetName 

func (e *EntityOnboardingStatus) GetName() *string

func (*EntityOnboardingStatus) GetResource 

func (e *EntityOnboardingStatus) GetResource() *string

func (*EntityOnboardingStatus) GetSignedUpAt 

func (e *EntityOnboardingStatus) GetSignedUpAt() *string

func (*EntityOnboardingStatus) GetStatus 

func (e *EntityOnboardingStatus) GetStatus() *OnboardingStatus
type EntityOnboardingStatusLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self *URLObj `json:"self,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Dashboard *URLObj `json:"dashboard,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Organization *URLObj `json:"organization,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation *URLObj `json:"documentation,omitempty"`
}

EntityOnboardingStatusLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.

func (*EntityOnboardingStatusLinks) GetDashboard 

func (e *EntityOnboardingStatusLinks) GetDashboard() *URLObj

func (*EntityOnboardingStatusLinks) GetDocumentation 

func (e *EntityOnboardingStatusLinks) GetDocumentation() *URLObj

func (*EntityOnboardingStatusLinks) GetOrganization 

func (e *EntityOnboardingStatusLinks) GetOrganization() *URLObj

func (*EntityOnboardingStatusLinks) GetSelf 

func (e *EntityOnboardingStatusLinks) GetSelf() *URLObj

type EntityOrganization 

type EntityOrganization struct {
	// Indicates the response contains an organization object. Will always contain the string `organization` for this
	// resource type.
	Resource *string `json:"resource,omitempty"`
	// The identifier uniquely referring to this organization. Example: `org_12345678`.
	ID *string `json:"id,omitempty"`
	// The name of the organization.
	Name *string `json:"name,omitempty"`
	// The email address associated with the organization.
	Email *string `json:"email,omitempty"`
	// Allows you to preset the language to be used.
	Locale  *LocaleResponse `json:"locale,omitempty"`
	Address *Address        `json:"address,omitempty"`
	// The registration number of the organization at their local chamber of commerce.
	RegistrationNumber *string `json:"registrationNumber,omitempty"`
	// The VAT number of the organization, if based in the European Union or in The United Kingdom. VAT numbers are
	// verified against the international registry *VIES*.
	//
	// The field is not present for merchants residing in other countries.
	VatNumber *string `json:"vatNumber,omitempty"`
	// Mollie applies Dutch VAT for merchants based in The Netherlands, British VAT for merchants based in The United
	// Kingdom, and shifted VAT for merchants in the European Union.
	//
	// The field is not present for merchants residing in other countries.
	VatRegulation *OrganizationVatRegulation `json:"vatRegulation,omitempty"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links *EntityOrganizationLinks `json:"_links,omitempty"`
}

func (*EntityOrganization) GetAddress 

func (e *EntityOrganization) GetAddress() *Address

func (*EntityOrganization) GetEmail 

func (e *EntityOrganization) GetEmail() *string

func (*EntityOrganization) GetID 

func (e *EntityOrganization) GetID() *string
func (e *EntityOrganization) GetLinks() *EntityOrganizationLinks

func (*EntityOrganization) GetLocale 

func (e *EntityOrganization) GetLocale() *LocaleResponse

func (*EntityOrganization) GetName 

func (e *EntityOrganization) GetName() *string

func (*EntityOrganization) GetRegistrationNumber 

func (e *EntityOrganization) GetRegistrationNumber() *string

func (*EntityOrganization) GetResource 

func (e *EntityOrganization) GetResource() *string

func (*EntityOrganization) GetVatNumber 

func (e *EntityOrganization) GetVatNumber() *string

func (*EntityOrganization) GetVatRegulation 

func (e *EntityOrganization) GetVatRegulation() *OrganizationVatRegulation
type EntityOrganizationLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self *URLObj `json:"self,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Dashboard *URLObj `json:"dashboard,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation *URLObj `json:"documentation,omitempty"`
}

EntityOrganizationLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.

func (*EntityOrganizationLinks) GetDashboard 

func (e *EntityOrganizationLinks) GetDashboard() *URLObj

func (*EntityOrganizationLinks) GetDocumentation 

func (e *EntityOrganizationLinks) GetDocumentation() *URLObj

func (*EntityOrganizationLinks) GetSelf 

func (e *EntityOrganizationLinks) GetSelf() *URLObj

type EntityPaymentRoute 

type EntityPaymentRoute struct {
	ID string `json:"id"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount Amount `json:"amount"`
	// The destination of this portion of the payment.
	Destination EntityPaymentRouteDestination `json:"destination"`
	// Optionally, schedule this portion of the payment to be transferred to its destination on a later date. The
	// date must be given in `YYYY-MM-DD` format.
	//
	// If no date is given, the funds become available to the connected merchant as soon as the payment succeeds.
	ReleaseDate *string `json:"releaseDate,omitempty"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links EntityPaymentRouteLinks `json:"_links"`
}

func (*EntityPaymentRoute) GetAmount 

func (e *EntityPaymentRoute) GetAmount() Amount

func (*EntityPaymentRoute) GetDestination 

func (e *EntityPaymentRoute) GetDestination() EntityPaymentRouteDestination

func (*EntityPaymentRoute) GetID 

func (e *EntityPaymentRoute) GetID() string
func (e *EntityPaymentRoute) GetLinks() EntityPaymentRouteLinks

func (*EntityPaymentRoute) GetReleaseDate 

func (e *EntityPaymentRoute) GetReleaseDate() *string

type EntityPaymentRouteDestination 

type EntityPaymentRouteDestination struct {
	// The type of destination. Currently only the destination type `organization` is supported.
	Type           RouteDestinationType `json:"type"`
	OrganizationID string               `json:"organizationId"`
}

EntityPaymentRouteDestination - The destination of this portion of the payment.

func (*EntityPaymentRouteDestination) GetOrganizationID 

func (e *EntityPaymentRouteDestination) GetOrganizationID() string

func (*EntityPaymentRouteDestination) GetType 

func (e *EntityPaymentRouteDestination) GetType() RouteDestinationType
type EntityPaymentRouteLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self URLObj `json:"self"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Payment URLObj `json:"payment"`
}

EntityPaymentRouteLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.

func (*EntityPaymentRouteLinks) GetPayment 

func (e *EntityPaymentRouteLinks) GetPayment() URLObj

func (*EntityPaymentRouteLinks) GetSelf 

func (e *EntityPaymentRouteLinks) GetSelf() URLObj

type EntityPaymentRouteResponse 

type EntityPaymentRouteResponse struct {
	// Indicates the response contains a route object. Will always contain the string `route` for this endpoint.
	Resource string `json:"resource"`
	ID       string `json:"id"`
	// Whether this entity was created in live mode or in test mode.
	Mode Mode `json:"mode"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount Amount `json:"amount"`
	// The destination of this portion of the payment.
	Destination EntityPaymentRouteResponseDestination `json:"destination"`
	// The date and time when the route was created. The date is given in ISO 8601 format.
	CreatedAt string `json:"createdAt"`
	// Optionally, schedule this portion of the payment to be transferred to its destination on a later date. The
	// date must be given in `YYYY-MM-DD` format.
	//
	// If no date is given, the funds become available to the connected merchant as soon as the payment succeeds.
	ReleaseDate *string `json:"releaseDate,omitempty"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links EntityPaymentRouteResponseLinks `json:"_links"`
}

func (*EntityPaymentRouteResponse) GetAmount 

func (e *EntityPaymentRouteResponse) GetAmount() Amount

func (*EntityPaymentRouteResponse) GetCreatedAt 

func (e *EntityPaymentRouteResponse) GetCreatedAt() string

func (*EntityPaymentRouteResponse) GetDestination 

func (e *EntityPaymentRouteResponse) GetDestination() EntityPaymentRouteResponseDestination

func (*EntityPaymentRouteResponse) GetID 

func (e *EntityPaymentRouteResponse) GetID() string
func (e *EntityPaymentRouteResponse) GetLinks() EntityPaymentRouteResponseLinks

func (*EntityPaymentRouteResponse) GetMode 

func (e *EntityPaymentRouteResponse) GetMode() Mode

func (*EntityPaymentRouteResponse) GetReleaseDate 

func (e *EntityPaymentRouteResponse) GetReleaseDate() *string

func (*EntityPaymentRouteResponse) GetResource 

func (e *EntityPaymentRouteResponse) GetResource() string

type EntityPaymentRouteResponseDestination 

type EntityPaymentRouteResponseDestination struct {
	// The type of destination. Currently only the destination type `organization` is supported.
	Type           RouteDestinationTypeResponse `json:"type"`
	OrganizationID string                       `json:"organizationId"`
}

EntityPaymentRouteResponseDestination - The destination of this portion of the payment.

func (*EntityPaymentRouteResponseDestination) GetOrganizationID 

func (e *EntityPaymentRouteResponseDestination) GetOrganizationID() string

func (*EntityPaymentRouteResponseDestination) GetType 

func (e *EntityPaymentRouteResponseDestination) GetType() RouteDestinationTypeResponse
type EntityPaymentRouteResponseLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self URLObj `json:"self"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Payment URLObj `json:"payment"`
}

EntityPaymentRouteResponseLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.

func (*EntityPaymentRouteResponseLinks) GetPayment 

func (e *EntityPaymentRouteResponseLinks) GetPayment() URLObj

func (*EntityPaymentRouteResponseLinks) GetSelf 

func (e *EntityPaymentRouteResponseLinks) GetSelf() URLObj

type EntityPermission 

type EntityPermission struct {
	// Indicates the response contains a permission object. Will always contain the string `permission` for this
	// endpoint.
	Resource *string `json:"resource,omitempty"`
	ID       *string `json:"id,omitempty"`
	// A short description of what kind of access the permission enables.
	Description *string `json:"description,omitempty"`
	// Whether this permission is granted to the app by the organization.
	Granted *bool `json:"granted,omitempty"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links *EntityPermissionLinks `json:"_links,omitempty"`
}

func (*EntityPermission) GetDescription 

func (e *EntityPermission) GetDescription() *string

func (*EntityPermission) GetGranted 

func (e *EntityPermission) GetGranted() *bool

func (*EntityPermission) GetID 

func (e *EntityPermission) GetID() *string
func (e *EntityPermission) GetLinks() *EntityPermissionLinks

func (*EntityPermission) GetResource 

func (e *EntityPermission) GetResource() *string
type EntityPermissionLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self *URLObj `json:"self,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation *URLObj `json:"documentation,omitempty"`
}

EntityPermissionLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.

func (*EntityPermissionLinks) GetDocumentation 

func (e *EntityPermissionLinks) GetDocumentation() *URLObj

func (*EntityPermissionLinks) GetSelf 

func (e *EntityPermissionLinks) GetSelf() *URLObj

type EntityProfile 

type EntityProfile struct {
	// The profile's name, this will usually reflect the trade name or brand name of the profile's website or
	// application.
	Name *string `json:"name,omitempty"`
	// The URL to the profile's website or application. Only `https` or `http` URLs are allowed. No `@` signs are
	// allowed.
	Website *string `json:"website,omitempty"`
	// The email address associated with the profile's trade name or brand.
	Email *string `json:"email,omitempty"`
	// The phone number associated with the profile's trade name or brand.
	Phone *string `json:"phone,omitempty"`
	// The products or services offered by the profile's website or application.
	Description *string `json:"description,omitempty"`
	// A list of countries where you expect that the majority of the profile's customers reside,
	// in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
	CountriesOfActivity []string `json:"countriesOfActivity,omitempty"`
	// The industry associated with the profile's trade name or brand. Please refer to the
	// [business category list](common-data-types#business-category) for all possible options.
	BusinessCategory *string `json:"businessCategory,omitempty"`
	// The profile status determines whether the profile is able to receive live payments.
	//
	// * `unverified`: The profile has not been verified yet and can only be used to create test payments.
	// * `verified`: The profile has been verified and can be used to create live payments and test payments.
	// * `blocked`: The profile is blocked and can no longer be used or changed.
	Status *ProfileStatus `json:"status,omitempty"`
}

func (*EntityProfile) GetBusinessCategory 

func (e *EntityProfile) GetBusinessCategory() *string

func (*EntityProfile) GetCountriesOfActivity 

func (e *EntityProfile) GetCountriesOfActivity() []string

func (*EntityProfile) GetDescription 

func (e *EntityProfile) GetDescription() *string

func (*EntityProfile) GetEmail 

func (e *EntityProfile) GetEmail() *string

func (*EntityProfile) GetName 

func (e *EntityProfile) GetName() *string

func (*EntityProfile) GetPhone 

func (e *EntityProfile) GetPhone() *string

func (*EntityProfile) GetStatus 

func (e *EntityProfile) GetStatus() *ProfileStatus

func (*EntityProfile) GetWebsite 

func (e *EntityProfile) GetWebsite() *string

type EntityProfileResponse 

type EntityProfileResponse struct {
	// Indicates the response contains a profile object. Will always contain the string `profile` for this endpoint.
	Resource *string `json:"resource,omitempty"`
	// The identifier uniquely referring to this profile. Example: `pfl_v9hTwCvYqw`.
	ID *string `json:"id,omitempty"`
	// Whether this entity was created in live mode or in test mode.
	Mode *Mode `json:"mode,omitempty"`
	// The profile's name, this will usually reflect the trade name or brand name of the profile's website or
	// application.
	Name *string `json:"name,omitempty"`
	// The URL to the profile's website or application. Only `https` or `http` URLs are allowed. No `@` signs are
	// allowed.
	Website *string `json:"website,omitempty"`
	// The email address associated with the profile's trade name or brand.
	Email *string `json:"email,omitempty"`
	// The phone number associated with the profile's trade name or brand.
	Phone *string `json:"phone,omitempty"`
	// The products or services offered by the profile's website or application.
	Description *string `json:"description,omitempty"`
	// A list of countries where you expect that the majority of the profile's customers reside,
	// in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
	CountriesOfActivity []string `json:"countriesOfActivity,omitempty"`
	// The industry associated with the profile's trade name or brand. Please refer to the
	// [business category list](common-data-types#business-category) for all possible options.
	BusinessCategory *string `json:"businessCategory,omitempty"`
	// The profile status determines whether the profile is able to receive live payments.
	//
	// * `unverified`: The profile has not been verified yet and can only be used to create test payments.
	// * `verified`: The profile has been verified and can be used to create live payments and test payments.
	// * `blocked`: The profile is blocked and can no longer be used or changed.
	Status *ProfileStatus `json:"status,omitempty"`
	// Present if changes have been made that have not yet been approved by Mollie. Changes to test profiles are approved
	// automatically, unless a switch to a live profile has been requested. The review object will therefore usually be
	// `null` in test mode.
	Review *Review `json:"review,omitempty"`
	// The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	CreatedAt *string `json:"createdAt,omitempty"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links *EntityProfileResponseLinks `json:"_links,omitempty"`
}

func (*EntityProfileResponse) GetBusinessCategory 

func (e *EntityProfileResponse) GetBusinessCategory() *string

func (*EntityProfileResponse) GetCountriesOfActivity 

func (e *EntityProfileResponse) GetCountriesOfActivity() []string

func (*EntityProfileResponse) GetCreatedAt 

func (e *EntityProfileResponse) GetCreatedAt() *string

func (*EntityProfileResponse) GetDescription 

func (e *EntityProfileResponse) GetDescription() *string

func (*EntityProfileResponse) GetEmail 

func (e *EntityProfileResponse) GetEmail() *string

func (*EntityProfileResponse) GetID 

func (e *EntityProfileResponse) GetID() *string
func (e *EntityProfileResponse) GetLinks() *EntityProfileResponseLinks

func (*EntityProfileResponse) GetMode 

func (e *EntityProfileResponse) GetMode() *Mode

func (*EntityProfileResponse) GetName 

func (e *EntityProfileResponse) GetName() *string

func (*EntityProfileResponse) GetPhone 

func (e *EntityProfileResponse) GetPhone() *string

func (*EntityProfileResponse) GetResource 

func (e *EntityProfileResponse) GetResource() *string

func (*EntityProfileResponse) GetReview 

func (e *EntityProfileResponse) GetReview() *Review

func (*EntityProfileResponse) GetStatus 

func (e *EntityProfileResponse) GetStatus() *ProfileStatus

func (*EntityProfileResponse) GetWebsite 

func (e *EntityProfileResponse) GetWebsite() *string

func (EntityProfileResponse) MarshalJSON 

func (e EntityProfileResponse) MarshalJSON() ([]byte, error)

func (*EntityProfileResponse) UnmarshalJSON 

func (e *EntityProfileResponse) UnmarshalJSON(data []byte) error
type EntityProfileResponseLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self *URLObj `json:"self,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Dashboard *URLObj `json:"dashboard,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Chargebacks *URLObj `json:"chargebacks,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Methods *URLObj `json:"methods,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Payments *URLObj `json:"payments,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Refunds *URLObj `json:"refunds,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	CheckoutPreviewURL *URLObj `json:"checkoutPreviewUrl,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation *URLObj `json:"documentation,omitempty"`
}

EntityProfileResponseLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.

func (*EntityProfileResponseLinks) GetChargebacks 

func (e *EntityProfileResponseLinks) GetChargebacks() *URLObj

func (*EntityProfileResponseLinks) GetCheckoutPreviewURL 

func (e *EntityProfileResponseLinks) GetCheckoutPreviewURL() *URLObj

func (*EntityProfileResponseLinks) GetDashboard 

func (e *EntityProfileResponseLinks) GetDashboard() *URLObj

func (*EntityProfileResponseLinks) GetDocumentation 

func (e *EntityProfileResponseLinks) GetDocumentation() *URLObj

func (*EntityProfileResponseLinks) GetMethods 

func (e *EntityProfileResponseLinks) GetMethods() *URLObj

func (*EntityProfileResponseLinks) GetPayments 

func (e *EntityProfileResponseLinks) GetPayments() *URLObj

func (*EntityProfileResponseLinks) GetRefunds 

func (e *EntityProfileResponseLinks) GetRefunds() *URLObj

func (*EntityProfileResponseLinks) GetSelf 

func (e *EntityProfileResponseLinks) GetSelf() *URLObj

func (EntityProfileResponseLinks) MarshalJSON 

func (e EntityProfileResponseLinks) MarshalJSON() ([]byte, error)

func (*EntityProfileResponseLinks) UnmarshalJSON 

func (e *EntityProfileResponseLinks) UnmarshalJSON(data []byte) error

type EntityRefund 

type EntityRefund struct {
	ID string `json:"id"`
	// The description of the refund that may be shown to your customer, depending on the payment method used.
	Description string `json:"description"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount Amount `json:"amount"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	SettlementAmount *AmountNullable `json:"settlementAmount,omitempty"`
	// Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever
	// you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
	Metadata          *Metadata                      `json:"metadata"`
	PaymentID         *string                        `json:"paymentId,omitempty"`
	SettlementID      *string                        `json:"settlementId,omitempty"`
	Status            RefundStatus                   `json:"status"`
	ExternalReference *EntityRefundExternalReference `json:"externalReference,omitempty"`
	// *This feature is only available to marketplace operators.*
	//
	// With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie
	// merchants, by providing the `routing` object during [payment creation](create-payment).
	//
	// When creating refunds for these *routed* payments, by default the full amount is deducted from your balance.
	//
	// If you want to pull back the funds that were routed to the connected merchant(s), you can set this parameter to
	// `true` when issuing a full refund.
	//
	// For more fine-grained control and for partial refunds, use the `routingReversals` parameter instead.
	ReverseRouting *bool `json:"reverseRouting,omitempty"`
	// *This feature is only available to marketplace operators.*
	//
	// When creating refunds for *routed* payments, by default the full amount is deducted from your balance.
	//
	// If you want to pull back funds from the connected merchant(s), you can use this parameter to specify what amount
	// needs to be reversed from which merchant(s).
	//
	// If you simply want to fully reverse the routed funds, you can also use the `reverseRouting` parameter instead.
	RoutingReversals []EntityRefundRoutingReversal `json:"routingReversals,omitempty"`
	// Whether to create the entity in test mode or live mode.
	//
	// Most API credentials are specifically created for either live mode or test mode, in which case this parameter can be
	// omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting
	// `testmode` to `true`.
	Testmode *bool `json:"testmode,omitempty"`
}

func (*EntityRefund) GetAmount 

func (e *EntityRefund) GetAmount() Amount

func (*EntityRefund) GetDescription 

func (e *EntityRefund) GetDescription() string

func (*EntityRefund) GetExternalReference 

func (e *EntityRefund) GetExternalReference() *EntityRefundExternalReference

func (*EntityRefund) GetID 

func (e *EntityRefund) GetID() string

func (*EntityRefund) GetMetadata 

func (e *EntityRefund) GetMetadata() *Metadata

func (*EntityRefund) GetPaymentID 

func (e *EntityRefund) GetPaymentID() *string

func (*EntityRefund) GetReverseRouting 

func (e *EntityRefund) GetReverseRouting() *bool

func (*EntityRefund) GetRoutingReversals 

func (e *EntityRefund) GetRoutingReversals() []EntityRefundRoutingReversal

func (*EntityRefund) GetSettlementAmount 

func (e *EntityRefund) GetSettlementAmount() *AmountNullable

func (*EntityRefund) GetSettlementID 

func (e *EntityRefund) GetSettlementID() *string

func (*EntityRefund) GetStatus 

func (e *EntityRefund) GetStatus() RefundStatus

func (*EntityRefund) GetTestmode 

func (e *EntityRefund) GetTestmode() *bool

type EntityRefundExternalReference 

type EntityRefundExternalReference struct {
	// Specifies the reference type
	Type *RefundExternalReferenceType `json:"type,omitempty"`
	// Unique reference from the payment provider
	ID *string `json:"id,omitempty"`
}

func (*EntityRefundExternalReference) GetID 

func (e *EntityRefundExternalReference) GetID() *string

func (*EntityRefundExternalReference) GetType 

func (e *EntityRefundExternalReference) GetType() *RefundExternalReferenceType

type EntityRefundResponse 

type EntityRefundResponse struct {
	// Indicates the response contains a refund object. Will always contain the string `refund` for this endpoint.
	Resource string `json:"resource"`
	ID       string `json:"id"`
	// Whether this entity was created in live mode or in test mode.
	Mode Mode `json:"mode"`
	// The description of the refund that may be shown to your customer, depending on the payment method used.
	Description string `json:"description"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount Amount `json:"amount"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	SettlementAmount *AmountNullable `json:"settlementAmount,omitempty"`
	// Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever
	// you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
	Metadata     *Metadata    `json:"metadata"`
	PaymentID    *string      `json:"paymentId,omitempty"`
	SettlementID *string      `json:"settlementId,omitempty"`
	Status       RefundStatus `json:"status"`
	// The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	CreatedAt         string                                 `json:"createdAt"`
	ExternalReference *EntityRefundResponseExternalReference `json:"externalReference,omitempty"`
	// *This feature is only available to marketplace operators.*
	//
	// When creating refunds for *routed* payments, by default the full amount is deducted from your balance.
	//
	// If you want to pull back funds from the connected merchant(s), you can use this parameter to specify what amount
	// needs to be reversed from which merchant(s).
	//
	// If you simply want to fully reverse the routed funds, you can also use the `reverseRouting` parameter instead.
	RoutingReversals []EntityRefundResponseRoutingReversal `json:"routingReversals,omitempty"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links EntityRefundResponseLinks `json:"_links"`
}

func (*EntityRefundResponse) GetAmount 

func (e *EntityRefundResponse) GetAmount() Amount

func (*EntityRefundResponse) GetCreatedAt 

func (e *EntityRefundResponse) GetCreatedAt() string

func (*EntityRefundResponse) GetDescription 

func (e *EntityRefundResponse) GetDescription() string

func (*EntityRefundResponse) GetExternalReference 

func (e *EntityRefundResponse) GetExternalReference() *EntityRefundResponseExternalReference

func (*EntityRefundResponse) GetID 

func (e *EntityRefundResponse) GetID() string
func (e *EntityRefundResponse) GetLinks() EntityRefundResponseLinks

func (*EntityRefundResponse) GetMetadata 

func (e *EntityRefundResponse) GetMetadata() *Metadata

func (*EntityRefundResponse) GetMode 

func (e *EntityRefundResponse) GetMode() Mode

func (*EntityRefundResponse) GetPaymentID 

func (e *EntityRefundResponse) GetPaymentID() *string

func (*EntityRefundResponse) GetResource 

func (e *EntityRefundResponse) GetResource() string

func (*EntityRefundResponse) GetRoutingReversals 

func (e *EntityRefundResponse) GetRoutingReversals() []EntityRefundResponseRoutingReversal

func (*EntityRefundResponse) GetSettlementAmount 

func (e *EntityRefundResponse) GetSettlementAmount() *AmountNullable

func (*EntityRefundResponse) GetSettlementID 

func (e *EntityRefundResponse) GetSettlementID() *string

func (*EntityRefundResponse) GetStatus 

func (e *EntityRefundResponse) GetStatus() RefundStatus

type EntityRefundResponseExternalReference 

type EntityRefundResponseExternalReference struct {
	// Specifies the reference type
	Type *RefundExternalReferenceTypeResponse `json:"type,omitempty"`
	// Unique reference from the payment provider
	ID *string `json:"id,omitempty"`
}

func (*EntityRefundResponseExternalReference) GetID 

func (e *EntityRefundResponseExternalReference) GetID() *string

func (*EntityRefundResponseExternalReference) GetType 

func (e *EntityRefundResponseExternalReference) GetType() *RefundExternalReferenceTypeResponse
type EntityRefundResponseLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self URLObj `json:"self"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Payment URLObj `json:"payment"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Settlement *URLNullable `json:"settlement,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation URLObj `json:"documentation"`
}

EntityRefundResponseLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.

func (*EntityRefundResponseLinks) GetDocumentation 

func (e *EntityRefundResponseLinks) GetDocumentation() URLObj

func (*EntityRefundResponseLinks) GetPayment 

func (e *EntityRefundResponseLinks) GetPayment() URLObj

func (*EntityRefundResponseLinks) GetSelf 

func (e *EntityRefundResponseLinks) GetSelf() URLObj

func (*EntityRefundResponseLinks) GetSettlement 

func (e *EntityRefundResponseLinks) GetSettlement() *URLNullable

type EntityRefundResponseRoutingReversal 

type EntityRefundResponseRoutingReversal struct {
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount *Amount `json:"amount,omitempty"`
	// Where the funds will be pulled back from.
	Source *EntityRefundResponseSource `json:"source,omitempty"`
}

func (*EntityRefundResponseRoutingReversal) GetAmount 

func (e *EntityRefundResponseRoutingReversal) GetAmount() *Amount

func (*EntityRefundResponseRoutingReversal) GetSource 

func (e *EntityRefundResponseRoutingReversal) GetSource() *EntityRefundResponseSource

type EntityRefundResponseSource 

type EntityRefundResponseSource struct {
	// The type of source. Currently only the source type `organization` is supported.
	Type           *RefundRoutingReversalsSourceType `json:"type,omitempty"`
	OrganizationID *string                           `json:"organizationId,omitempty"`
}

EntityRefundResponseSource - Where the funds will be pulled back from.

func (*EntityRefundResponseSource) GetOrganizationID 

func (e *EntityRefundResponseSource) GetOrganizationID() *string

func (*EntityRefundResponseSource) GetType 

func (e *EntityRefundResponseSource) GetType() *RefundRoutingReversalsSourceType

type EntityRefundRoutingReversal 

type EntityRefundRoutingReversal struct {
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount *Amount `json:"amount,omitempty"`
	// Where the funds will be pulled back from.
	Source *EntityRefundSource `json:"source,omitempty"`
}

func (*EntityRefundRoutingReversal) GetAmount 

func (e *EntityRefundRoutingReversal) GetAmount() *Amount

func (*EntityRefundRoutingReversal) GetSource 

func (e *EntityRefundRoutingReversal) GetSource() *EntityRefundSource

type EntityRefundSource 

type EntityRefundSource struct {
	// The type of source. Currently only the source type `organization` is supported.
	Type           *RefundRoutingReversalsSourceType `json:"type,omitempty"`
	OrganizationID *string                           `json:"organizationId,omitempty"`
}

EntityRefundSource - Where the funds will be pulled back from.

func (*EntityRefundSource) GetOrganizationID 

func (e *EntityRefundSource) GetOrganizationID() *string

func (*EntityRefundSource) GetType 

func (e *EntityRefundSource) GetType() *RefundRoutingReversalsSourceType

type EntitySalesInvoice 

type EntitySalesInvoice struct {
	ID *string `json:"id,omitempty"`
	// Whether to create the entity in test mode or live mode.
	//
	// Most API credentials are specifically created for either live mode or test mode, in which case this parameter can be
	// omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting
	// `testmode` to `true`.
	Testmode *bool `json:"testmode,omitempty"`
	// The identifier referring to the [profile](get-profile) this entity belongs to.
	//
	// Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted in the creation
	// request. For organization-level credentials such as OAuth access tokens however, the `profileId` parameter is
	// required.
	ProfileID *string `json:"profileId,omitempty"`
	// The status for the invoice to end up in.
	//
	// A `draft` invoice is not paid or not sent and can be updated after creation. Setting it to `issued` sends it to
	// the recipient so they may then pay through our payment system. To skip our payment process, set this to `paid` to
	// mark it as paid. It can then subsequently be sent as well, same as with `issued`.
	//
	// A status value that cannot be set but can be returned is `canceled`, for invoices which were
	// issued, but then canceled. Currently this can only be done for invoices created in the dashboard.
	//
	// Dependent parameters:
	//   - `paymentDetails` is required if invoice should be set directly to `paid`
	//   - `customerId` and `mandateId` are required if a recurring payment should be used to set the invoice to `paid`
	//   - `emailDetails` optional for `issued` and `paid` to send the invoice by email
	Status *SalesInvoiceStatus `json:"status,omitempty"`
	// The VAT scheme to create the invoice for. You must be enrolled with One Stop Shop enabled to use it.
	VatScheme *SalesInvoiceVatScheme `json:"vatScheme,omitempty"`
	// The VAT mode to use for VAT calculation. `exclusive` mode means we will apply the relevant VAT on top of the
	// price. `inclusive` means the prices you are providing to us already contain the VAT you want to apply.
	VatMode *SalesInvoiceVatMode `json:"vatMode,omitempty"`
	// A free-form memo you can set on the invoice, and will be shown on the invoice PDF.
	Memo *string `json:"memo,omitempty"`
	// Provide any data you like as a JSON object. We will save the data alongside the entity. Whenever
	// you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
	Metadata *EntitySalesInvoiceMetadata `json:"metadata,omitempty"`
	// The payment term to be set on the invoice.
	PaymentTerm    *SalesInvoicePaymentTerm    `json:"paymentTerm,omitempty"`
	PaymentDetails *SalesInvoicePaymentDetails `json:"paymentDetails,omitempty"`
	EmailDetails   *SalesInvoiceEmailDetails   `json:"emailDetails,omitempty"`
	// The identifier referring to the [customer](get-customer) you want to attempt an automated payment for. If
	// provided, `mandateId` becomes required as well. Only allowed for invoices with status `paid`.
	CustomerID *string `json:"customerId,omitempty"`
	// The identifier referring to the [mandate](get-mandate) you want to use for the automated payment. If provided,
	// `customerId` becomes required as well. Only allowed for invoices with status `paid`.
	MandateID *string `json:"mandateId,omitempty"`
	// An identifier tied to the recipient data. This should be a unique value based on data your system contains,
	// so that both you and us know who we're referring to. It is a value you provide to us so that recipient management
	// is not required to send a first invoice to a recipient.
	RecipientIdentifier *string                `json:"recipientIdentifier,omitempty"`
	Recipient           *SalesInvoiceRecipient `json:"recipient,omitempty"`
	// Provide the line items for the invoice. Each line contains details such as a description of the item
	// ordered and its price.
	//
	// All lines must have the same currency as the invoice.
	Lines    []SalesInvoiceLineItem `json:"lines,omitempty"`
	Discount *SalesInvoiceDiscount  `json:"discount,omitempty"`
	// This indicates whether the invoice is an e-invoice. The default value is `false` and can't be changed
	// after the invoice has been issued. When `emailDetails` is provided, an additional email is sent to the
	// recipient.
	//
	// E-invoicing is only available for merchants based in Belgium, Germany, and the Netherlands, and only when
	// the recipient is also located in one of these countries.
	IsEInvoice *bool `json:"isEInvoice,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	AmountDue *Amount `json:"amountDue,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	SubtotalAmount *Amount `json:"subtotalAmount,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	TotalAmount *Amount `json:"totalAmount,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	TotalVatAmount *Amount `json:"totalVatAmount,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	DiscountedSubtotalAmount *Amount `json:"discountedSubtotalAmount,omitempty"`
}

func (*EntitySalesInvoice) GetAmountDue 

func (e *EntitySalesInvoice) GetAmountDue() *Amount

func (*EntitySalesInvoice) GetCustomerID 

func (e *EntitySalesInvoice) GetCustomerID() *string

func (*EntitySalesInvoice) GetDiscount 

func (e *EntitySalesInvoice) GetDiscount() *SalesInvoiceDiscount

func (*EntitySalesInvoice) GetDiscountedSubtotalAmount 

func (e *EntitySalesInvoice) GetDiscountedSubtotalAmount() *Amount

func (*EntitySalesInvoice) GetEmailDetails 

func (e *EntitySalesInvoice) GetEmailDetails() *SalesInvoiceEmailDetails

func (*EntitySalesInvoice) GetID 

func (e *EntitySalesInvoice) GetID() *string

func (*EntitySalesInvoice) GetIsEInvoice added in v0.3.0 

func (e *EntitySalesInvoice) GetIsEInvoice() *bool

func (*EntitySalesInvoice) GetLines 

func (e *EntitySalesInvoice) GetLines() []SalesInvoiceLineItem

func (*EntitySalesInvoice) GetMandateID 

func (e *EntitySalesInvoice) GetMandateID() *string

func (*EntitySalesInvoice) GetMemo 

func (e *EntitySalesInvoice) GetMemo() *string

func (*EntitySalesInvoice) GetMetadata 

func (e *EntitySalesInvoice) GetMetadata() *EntitySalesInvoiceMetadata

func (*EntitySalesInvoice) GetPaymentDetails 

func (e *EntitySalesInvoice) GetPaymentDetails() *SalesInvoicePaymentDetails

func (*EntitySalesInvoice) GetPaymentTerm 

func (e *EntitySalesInvoice) GetPaymentTerm() *SalesInvoicePaymentTerm

func (*EntitySalesInvoice) GetProfileID 

func (e *EntitySalesInvoice) GetProfileID() *string

func (*EntitySalesInvoice) GetRecipient 

func (e *EntitySalesInvoice) GetRecipient() *SalesInvoiceRecipient

func (*EntitySalesInvoice) GetRecipientIdentifier 

func (e *EntitySalesInvoice) GetRecipientIdentifier() *string

func (*EntitySalesInvoice) GetStatus 

func (e *EntitySalesInvoice) GetStatus() *SalesInvoiceStatus

func (*EntitySalesInvoice) GetSubtotalAmount 

func (e *EntitySalesInvoice) GetSubtotalAmount() *Amount

func (*EntitySalesInvoice) GetTestmode 

func (e *EntitySalesInvoice) GetTestmode() *bool

func (*EntitySalesInvoice) GetTotalAmount 

func (e *EntitySalesInvoice) GetTotalAmount() *Amount

func (*EntitySalesInvoice) GetTotalVatAmount 

func (e *EntitySalesInvoice) GetTotalVatAmount() *Amount

func (*EntitySalesInvoice) GetVatMode 

func (e *EntitySalesInvoice) GetVatMode() *SalesInvoiceVatMode

func (*EntitySalesInvoice) GetVatScheme 

func (e *EntitySalesInvoice) GetVatScheme() *SalesInvoiceVatScheme

type EntitySalesInvoiceMetadata 

type EntitySalesInvoiceMetadata struct {
}

EntitySalesInvoiceMetadata - Provide any data you like as a JSON object. We will save the data alongside the entity. Whenever you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.

type EntitySalesInvoiceResponse 

type EntitySalesInvoiceResponse struct {
	// Indicates the response contains a sales invoice object. Will always contain the string `sales-invoice` for this
	// endpoint.
	Resource *string `json:"resource,omitempty"`
	ID       *string `json:"id,omitempty"`
	// When issued, an invoice number will be set for the sales invoice.
	InvoiceNumber *string `json:"invoiceNumber,omitempty"`
	// The status for the invoice to end up in.
	//
	// A `draft` invoice is not paid or not sent and can be updated after creation. Setting it to `issued` sends it to
	// the recipient so they may then pay through our payment system. To skip our payment process, set this to `paid` to
	// mark it as paid. It can then subsequently be sent as well, same as with `issued`.
	//
	// A status value that cannot be set but can be returned is `canceled`, for invoices which were
	// issued, but then canceled. Currently this can only be done for invoices created in the dashboard.
	//
	// Dependent parameters:
	//   - `paymentDetails` is required if invoice should be set directly to `paid`
	//   - `customerId` and `mandateId` are required if a recurring payment should be used to set the invoice to `paid`
	//   - `emailDetails` optional for `issued` and `paid` to send the invoice by email
	Status *SalesInvoiceStatusResponse `json:"status,omitempty"`
	// The VAT scheme to create the invoice for. You must be enrolled with One Stop Shop enabled to use it.
	VatScheme *SalesInvoiceVatSchemeResponse `json:"vatScheme,omitempty"`
	// The VAT mode to use for VAT calculation. `exclusive` mode means we will apply the relevant VAT on top of the
	// price. `inclusive` means the prices you are providing to us already contain the VAT you want to apply.
	VatMode *SalesInvoiceVatModeResponse `json:"vatMode,omitempty"`
	// A free-form memo you can set on the invoice, and will be shown on the invoice PDF.
	Memo *string `json:"memo,omitempty"`
	// Provide any data you like as a JSON object. We will save the data alongside the entity. Whenever
	// you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
	Metadata *EntitySalesInvoiceResponseMetadata `json:"metadata,omitempty"`
	// The payment term to be set on the invoice.
	PaymentTerm    *SalesInvoicePaymentTermResponse    `json:"paymentTerm,omitempty"`
	PaymentDetails *SalesInvoicePaymentDetailsResponse `json:"paymentDetails,omitempty"`
	EmailDetails   *SalesInvoiceEmailDetails           `json:"emailDetails,omitempty"`
	// The identifier referring to the [customer](get-customer) you want to attempt an automated payment for. If
	// provided, `mandateId` becomes required as well. Only allowed for invoices with status `paid`.
	CustomerID *string `json:"customerId,omitempty"`
	// The identifier referring to the [mandate](get-mandate) you want to use for the automated payment. If provided,
	// `customerId` becomes required as well. Only allowed for invoices with status `paid`.
	MandateID *string `json:"mandateId,omitempty"`
	// An identifier tied to the recipient data. This should be a unique value based on data your system contains,
	// so that both you and us know who we're referring to. It is a value you provide to us so that recipient management
	// is not required to send a first invoice to a recipient.
	RecipientIdentifier *string                        `json:"recipientIdentifier,omitempty"`
	Recipient           *SalesInvoiceRecipientResponse `json:"recipient,omitempty"`
	// Provide the line items for the invoice. Each line contains details such as a description of the item
	// ordered and its price.
	//
	// All lines must have the same currency as the invoice.
	Lines    []SalesInvoiceLineItemResponse `json:"lines,omitempty"`
	Discount *SalesInvoiceDiscountResponse  `json:"discount,omitempty"`
	// This indicates whether the invoice is an e-invoice. The default value is `false` and can't be changed
	// after the invoice has been issued. When `emailDetails` is provided, an additional email is sent to the
	// recipient.
	//
	// E-invoicing is only available for merchants based in Belgium, Germany, and the Netherlands, and only when
	// the recipient is also located in one of these countries.
	IsEInvoice *bool `json:"isEInvoice,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	AmountDue *Amount `json:"amountDue,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	SubtotalAmount *Amount `json:"subtotalAmount,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	TotalAmount *Amount `json:"totalAmount,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	TotalVatAmount *Amount `json:"totalVatAmount,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	DiscountedSubtotalAmount *Amount `json:"discountedSubtotalAmount,omitempty"`
	// The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	CreatedAt *string `json:"createdAt,omitempty"`
	// If issued, the date when the sales invoice was issued, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
	// format.
	IssuedAt *string `json:"issuedAt,omitempty"`
	// If paid, the date when the sales invoice was paid, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
	// format.
	PaidAt *string `json:"paidAt,omitempty"`
	// If issued, the date when the sales invoice payment is due, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
	// format.
	DueAt *string `json:"dueAt,omitempty"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links *EntitySalesInvoiceResponseLinks `json:"_links,omitempty"`
}

func (*EntitySalesInvoiceResponse) GetAmountDue 

func (e *EntitySalesInvoiceResponse) GetAmountDue() *Amount

func (*EntitySalesInvoiceResponse) GetCreatedAt 

func (e *EntitySalesInvoiceResponse) GetCreatedAt() *string

func (*EntitySalesInvoiceResponse) GetCustomerID 

func (e *EntitySalesInvoiceResponse) GetCustomerID() *string

func (*EntitySalesInvoiceResponse) GetDiscount 

func (e *EntitySalesInvoiceResponse) GetDiscount() *SalesInvoiceDiscountResponse

func (*EntitySalesInvoiceResponse) GetDiscountedSubtotalAmount 

func (e *EntitySalesInvoiceResponse) GetDiscountedSubtotalAmount() *Amount

func (*EntitySalesInvoiceResponse) GetDueAt 

func (e *EntitySalesInvoiceResponse) GetDueAt() *string

func (*EntitySalesInvoiceResponse) GetEmailDetails 

func (e *EntitySalesInvoiceResponse) GetEmailDetails() *SalesInvoiceEmailDetails

func (*EntitySalesInvoiceResponse) GetID 

func (e *EntitySalesInvoiceResponse) GetID() *string

func (*EntitySalesInvoiceResponse) GetInvoiceNumber 

func (e *EntitySalesInvoiceResponse) GetInvoiceNumber() *string

func (*EntitySalesInvoiceResponse) GetIsEInvoice added in v0.3.0 

func (e *EntitySalesInvoiceResponse) GetIsEInvoice() *bool

func (*EntitySalesInvoiceResponse) GetIssuedAt 

func (e *EntitySalesInvoiceResponse) GetIssuedAt() *string

func (*EntitySalesInvoiceResponse) GetLines 

func (e *EntitySalesInvoiceResponse) GetLines() []SalesInvoiceLineItemResponse
func (e *EntitySalesInvoiceResponse) GetLinks() *EntitySalesInvoiceResponseLinks

func (*EntitySalesInvoiceResponse) GetMandateID 

func (e *EntitySalesInvoiceResponse) GetMandateID() *string

func (*EntitySalesInvoiceResponse) GetMemo 

func (e *EntitySalesInvoiceResponse) GetMemo() *string

func (*EntitySalesInvoiceResponse) GetMetadata 

func (e *EntitySalesInvoiceResponse) GetMetadata() *EntitySalesInvoiceResponseMetadata

func (*EntitySalesInvoiceResponse) GetPaidAt 

func (e *EntitySalesInvoiceResponse) GetPaidAt() *string

func (*EntitySalesInvoiceResponse) GetPaymentDetails 

func (e *EntitySalesInvoiceResponse) GetPaymentDetails() *SalesInvoicePaymentDetailsResponse

func (*EntitySalesInvoiceResponse) GetPaymentTerm 

func (e *EntitySalesInvoiceResponse) GetPaymentTerm() *SalesInvoicePaymentTermResponse

func (*EntitySalesInvoiceResponse) GetRecipient 

func (e *EntitySalesInvoiceResponse) GetRecipient() *SalesInvoiceRecipientResponse

func (*EntitySalesInvoiceResponse) GetRecipientIdentifier 

func (e *EntitySalesInvoiceResponse) GetRecipientIdentifier() *string

func (*EntitySalesInvoiceResponse) GetResource 

func (e *EntitySalesInvoiceResponse) GetResource() *string

func (*EntitySalesInvoiceResponse) GetStatus 

func (e *EntitySalesInvoiceResponse) GetStatus() *SalesInvoiceStatusResponse

func (*EntitySalesInvoiceResponse) GetSubtotalAmount 

func (e *EntitySalesInvoiceResponse) GetSubtotalAmount() *Amount

func (*EntitySalesInvoiceResponse) GetTotalAmount 

func (e *EntitySalesInvoiceResponse) GetTotalAmount() *Amount

func (*EntitySalesInvoiceResponse) GetTotalVatAmount 

func (e *EntitySalesInvoiceResponse) GetTotalVatAmount() *Amount

func (*EntitySalesInvoiceResponse) GetVatMode 

func (e *EntitySalesInvoiceResponse) GetVatMode() *SalesInvoiceVatModeResponse

func (*EntitySalesInvoiceResponse) GetVatScheme 

func (e *EntitySalesInvoiceResponse) GetVatScheme() *SalesInvoiceVatSchemeResponse
type EntitySalesInvoiceResponseLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self *URLObj `json:"self,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	InvoicePayment *URLObj `json:"invoicePayment,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	PdfLink *URLObj `json:"pdfLink,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation *URLObj `json:"documentation,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Next *URLObj `json:"next,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Previous *URLObj `json:"previous,omitempty"`
}

EntitySalesInvoiceResponseLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.

func (*EntitySalesInvoiceResponseLinks) GetDocumentation 

func (e *EntitySalesInvoiceResponseLinks) GetDocumentation() *URLObj

func (*EntitySalesInvoiceResponseLinks) GetInvoicePayment 

func (e *EntitySalesInvoiceResponseLinks) GetInvoicePayment() *URLObj

func (*EntitySalesInvoiceResponseLinks) GetNext added in v0.3.0 

func (e *EntitySalesInvoiceResponseLinks) GetNext() *URLObj
func (e *EntitySalesInvoiceResponseLinks) GetPdfLink() *URLObj

func (*EntitySalesInvoiceResponseLinks) GetPrevious added in v0.3.0 

func (e *EntitySalesInvoiceResponseLinks) GetPrevious() *URLObj

func (*EntitySalesInvoiceResponseLinks) GetSelf 

func (e *EntitySalesInvoiceResponseLinks) GetSelf() *URLObj

type EntitySalesInvoiceResponseMetadata 

type EntitySalesInvoiceResponseMetadata struct {
}

EntitySalesInvoiceResponseMetadata - Provide any data you like as a JSON object. We will save the data alongside the entity. Whenever you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.

type EntitySettlement 

type EntitySettlement struct {
	// Indicates the response contains a settlement object. Will always contain the string `settlement` for this
	// endpoint.
	Resource string `json:"resource"`
	ID       string `json:"id"`
	// The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	CreatedAt *string `json:"createdAt,omitempty"`
	// The settlement's bank reference, as found in your Mollie account and on your bank statement.
	Reference *string `json:"reference,omitempty"`
	// The date on which the settlement was settled, in ISO 8601 format.
	//
	// For an [open settlement](get-open-settlement) or for the [next settlement](get-next-settlement), no settlement
	// date is available.
	SettledAt *string `json:"settledAt,omitempty"`
	// The status of the settlement.
	Status SettlementStatus `json:"status"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount    Amount  `json:"amount"`
	BalanceID string  `json:"balanceId"`
	InvoiceID *string `json:"invoiceId,omitempty"`
	// For bookkeeping purposes, the settlement includes an overview of transactions included in the settlement. These
	// transactions are grouped into 'period' objects — one for each calendar month.
	//
	// For example, if a settlement includes funds from 15 April until 4 May, it will include two period objects. One for
	// all transactions processed between 15 April and 30 April, and one for all transactions between 1 May and 4 May.
	//
	// Period objects are grouped by year, and then by month. So in the above example, the full `periods` collection will
	// look as follows: `{"2024": {"04": {...}, "05": {...}}}`. The year and month in this documentation are referred as `<year>` and `<month>`.
	//
	// The example response should give a good idea of what this looks like in practise.
	Periods map[string]map[string]Periods `json:"periods,omitempty"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links EntitySettlementLinks `json:"_links"`
}

func (*EntitySettlement) GetAmount 

func (e *EntitySettlement) GetAmount() Amount

func (*EntitySettlement) GetBalanceID 

func (e *EntitySettlement) GetBalanceID() string

func (*EntitySettlement) GetCreatedAt 

func (e *EntitySettlement) GetCreatedAt() *string

func (*EntitySettlement) GetID 

func (e *EntitySettlement) GetID() string

func (*EntitySettlement) GetInvoiceID 

func (e *EntitySettlement) GetInvoiceID() *string
func (e *EntitySettlement) GetLinks() EntitySettlementLinks

func (*EntitySettlement) GetPeriods 

func (e *EntitySettlement) GetPeriods() map[string]map[string]Periods

func (*EntitySettlement) GetReference 

func (e *EntitySettlement) GetReference() *string

func (*EntitySettlement) GetResource 

func (e *EntitySettlement) GetResource() string

func (*EntitySettlement) GetSettledAt 

func (e *EntitySettlement) GetSettledAt() *string

func (*EntitySettlement) GetStatus 

func (e *EntitySettlement) GetStatus() SettlementStatus
type EntitySettlementLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self URLObj `json:"self"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Payments *URLObj `json:"payments,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Captures *URLObj `json:"captures,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Refunds *URLObj `json:"refunds,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Chargebacks *URLObj `json:"chargebacks,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Invoice *URLNullable `json:"invoice,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation *URLObj `json:"documentation,omitempty"`
}

EntitySettlementLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.

func (*EntitySettlementLinks) GetCaptures 

func (e *EntitySettlementLinks) GetCaptures() *URLObj

func (*EntitySettlementLinks) GetChargebacks 

func (e *EntitySettlementLinks) GetChargebacks() *URLObj

func (*EntitySettlementLinks) GetDocumentation 

func (e *EntitySettlementLinks) GetDocumentation() *URLObj

func (*EntitySettlementLinks) GetInvoice 

func (e *EntitySettlementLinks) GetInvoice() *URLNullable

func (*EntitySettlementLinks) GetPayments 

func (e *EntitySettlementLinks) GetPayments() *URLObj

func (*EntitySettlementLinks) GetRefunds 

func (e *EntitySettlementLinks) GetRefunds() *URLObj

func (*EntitySettlementLinks) GetSelf 

func (e *EntitySettlementLinks) GetSelf() URLObj

type EntityTerminal 

type EntityTerminal struct {
	// Indicates the response contains a terminal object. Will always contain the string `terminal` for this endpoint.
	Resource string `json:"resource"`
	ID       string `json:"id"`
	// Whether this entity was created in live mode or in test mode.
	Mode Mode `json:"mode"`
	// A short description of the terminal. The description can be used as an identifier for the terminal. Currently, the
	// description is set when the terminal is initially configured. It will be visible in the Mollie Dashboard, and it
	// may be visible on the device itself depending on the device.
	Description string `json:"description"`
	// The status of the terminal.
	Status TerminalStatus `json:"status"`
	// The brand of the terminal.
	Brand *TerminalBrand `json:"brand"`
	// The model of the terminal. For example for a PAX A920, this field's value will be `A920`.
	Model *TerminalModel `json:"model"`
	// The serial number of the terminal. The serial number is provided at terminal creation time.
	SerialNumber *string `json:"serialNumber"`
	// The currency configured on the terminal, in ISO 4217 format. Currently most of our terminals are bound to a
	// specific currency, chosen during setup.
	Currency string `json:"currency"`
	// The identifier referring to the [profile](get-profile) this entity belongs to.
	//
	// Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted in the creation
	// request. For organization-level credentials such as OAuth access tokens however, the `profileId` parameter is
	// required.
	ProfileID string `json:"profileId"`
	// The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	CreatedAt string `json:"createdAt"`
	// The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	UpdatedAt string `json:"updatedAt"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links EntityTerminalLinks `json:"_links"`
}

func (*EntityTerminal) GetBrand 

func (e *EntityTerminal) GetBrand() *TerminalBrand

func (*EntityTerminal) GetCreatedAt 

func (e *EntityTerminal) GetCreatedAt() string

func (*EntityTerminal) GetCurrency 

func (e *EntityTerminal) GetCurrency() string

func (*EntityTerminal) GetDescription 

func (e *EntityTerminal) GetDescription() string

func (*EntityTerminal) GetID 

func (e *EntityTerminal) GetID() string
func (e *EntityTerminal) GetLinks() EntityTerminalLinks

func (*EntityTerminal) GetMode 

func (e *EntityTerminal) GetMode() Mode

func (*EntityTerminal) GetModel 

func (e *EntityTerminal) GetModel() *TerminalModel

func (*EntityTerminal) GetProfileID 

func (e *EntityTerminal) GetProfileID() string

func (*EntityTerminal) GetResource 

func (e *EntityTerminal) GetResource() string

func (*EntityTerminal) GetSerialNumber 

func (e *EntityTerminal) GetSerialNumber() *string

func (*EntityTerminal) GetStatus 

func (e *EntityTerminal) GetStatus() TerminalStatus

func (*EntityTerminal) GetUpdatedAt 

func (e *EntityTerminal) GetUpdatedAt() string
type EntityTerminalLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self URLObj `json:"self"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation URLObj `json:"documentation"`
}

EntityTerminalLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.

func (*EntityTerminalLinks) GetDocumentation 

func (e *EntityTerminalLinks) GetDocumentation() URLObj

func (*EntityTerminalLinks) GetSelf 

func (e *EntityTerminalLinks) GetSelf() URLObj

type EntityType 

type EntityType string
const (
	EntityTypePaymentLinkResponse   EntityType = "payment-link-response"
	EntityTypeEntityProfileResponse EntityType = "entity-profile-response"
)

type EntityWebhook 

type EntityWebhook struct {
	// Indicates the response contains a webhook subscription object.
	// Will always contain the string `webhook` for this endpoint.
	Resource string `json:"resource"`
	// The identifier uniquely referring to this subscription.
	ID string `json:"id"`
	// The subscription's events destination.
	URL string `json:"url"`
	// The identifier uniquely referring to the profile that created the subscription.
	ProfileID *string `json:"profileId"`
	// The subscription's date time of creation.
	CreatedAt string `json:"createdAt"`
	// The subscription's name.
	Name string `json:"name"`
	// The events types that are subscribed.
	EventTypes []WebhookEventTypes `json:"eventTypes"`
	// The subscription's current status.
	Status WebhookStatus `json:"status"`
	// Whether this entity was created in live mode or in test mode.
	Mode Mode `json:"mode"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links EntityWebhookLinks `json:"_links"`
}

func (*EntityWebhook) GetCreatedAt 

func (e *EntityWebhook) GetCreatedAt() string

func (*EntityWebhook) GetEventTypes 

func (e *EntityWebhook) GetEventTypes() []WebhookEventTypes

func (*EntityWebhook) GetID 

func (e *EntityWebhook) GetID() string
func (e *EntityWebhook) GetLinks() EntityWebhookLinks

func (*EntityWebhook) GetMode 

func (e *EntityWebhook) GetMode() Mode

func (*EntityWebhook) GetName 

func (e *EntityWebhook) GetName() string

func (*EntityWebhook) GetProfileID 

func (e *EntityWebhook) GetProfileID() *string

func (*EntityWebhook) GetResource 

func (e *EntityWebhook) GetResource() string

func (*EntityWebhook) GetStatus 

func (e *EntityWebhook) GetStatus() WebhookStatus

func (*EntityWebhook) GetURL 

func (e *EntityWebhook) GetURL() string

type EntityWebhookEvent 

type EntityWebhookEvent struct {
	// Indicates the response contains a webhook event object. Will always contain the string `event` for this endpoint.
	Resource string `json:"resource"`
	// The identifier uniquely referring to this event.
	ID string `json:"id"`
	// The event's type
	WebhookEventTypes WebhookEventTypes `json:"type"`
	// The entity token that triggered the event
	EntityID string `json:"entityId"`
	// The event's date time of creation.
	CreatedAt string `json:"createdAt"`
	// Full payload of the event.
	Embedded *Embedded `json:"_embedded,omitempty"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links EntityWebhookEventLinks `json:"_links"`
}

func (*EntityWebhookEvent) GetCreatedAt 

func (e *EntityWebhookEvent) GetCreatedAt() string

func (*EntityWebhookEvent) GetEmbedded 

func (e *EntityWebhookEvent) GetEmbedded() *Embedded

func (*EntityWebhookEvent) GetEntityID 

func (e *EntityWebhookEvent) GetEntityID() string

func (*EntityWebhookEvent) GetID 

func (e *EntityWebhookEvent) GetID() string
func (e *EntityWebhookEvent) GetLinks() EntityWebhookEventLinks

func (*EntityWebhookEvent) GetResource 

func (e *EntityWebhookEvent) GetResource() string

func (*EntityWebhookEvent) GetWebhookEventTypes 

func (e *EntityWebhookEvent) GetWebhookEventTypes() WebhookEventTypes
type EntityWebhookEventLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self URLObj `json:"self"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation URLObj `json:"documentation"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Entity *URLObj `json:"entity,omitempty"`
}

EntityWebhookEventLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.

func (*EntityWebhookEventLinks) GetDocumentation 

func (e *EntityWebhookEventLinks) GetDocumentation() URLObj

func (*EntityWebhookEventLinks) GetEntity 

func (e *EntityWebhookEventLinks) GetEntity() *URLObj

func (*EntityWebhookEventLinks) GetSelf 

func (e *EntityWebhookEventLinks) GetSelf() URLObj
type EntityWebhookLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self URLObj `json:"self"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation URLObj `json:"documentation"`
}

EntityWebhookLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.

func (*EntityWebhookLinks) GetDocumentation 

func (e *EntityWebhookLinks) GetDocumentation() URLObj

func (*EntityWebhookLinks) GetSelf added in v0.5.1 

func (e *EntityWebhookLinks) GetSelf() URLObj
type ErrorResponseLinks struct {
	// The URL to the generic Mollie API error handling guide.
	Documentation Documentation `json:"documentation"`
}

func (*ErrorResponseLinks) GetDocumentation 

func (e *ErrorResponseLinks) GetDocumentation() Documentation

type FailedPayment 

type FailedPayment struct {
	PaymentID          *string `json:"paymentId,omitempty"`
	PaymentDescription *string `json:"paymentDescription,omitempty"`
}

func (*FailedPayment) GetPaymentDescription 

func (f *FailedPayment) GetPaymentDescription() *string

func (*FailedPayment) GetPaymentID 

func (f *FailedPayment) GetPaymentID() *string

type FailedPaymentFee 

type FailedPaymentFee struct {
	PaymentID          *string `json:"paymentId,omitempty"`
	PaymentDescription *string `json:"paymentDescription,omitempty"`
}

func (*FailedPaymentFee) GetPaymentDescription 

func (f *FailedPaymentFee) GetPaymentDescription() *string

func (*FailedPaymentFee) GetPaymentID 

func (f *FailedPaymentFee) GetPaymentID() *string

type FeePrepayments 

type FeePrepayments struct {
	Pending              *SubGroup `json:"pending,omitempty"`
	MovedToAvailable     *SubGroup `json:"movedToAvailable,omitempty"`
	ImmediatelyAvailable *SubGroup `json:"immediatelyAvailable,omitempty"`
}

FeePrepayments - Only available on `transaction-categories` grouping.

func (*FeePrepayments) GetImmediatelyAvailable 

func (f *FeePrepayments) GetImmediatelyAvailable() *SubGroup

func (*FeePrepayments) GetMovedToAvailable 

func (f *FeePrepayments) GetMovedToAvailable() *SubGroup

func (*FeePrepayments) GetPending 

func (f *FeePrepayments) GetPending() *SubGroup

type HTTPMetadata 

type HTTPMetadata struct {
	// Raw HTTP response; suitable for custom response parsing
	Response *http.Response `json:"-"`
	// Raw HTTP request; suitable for debugging
	Request *http.Request `json:"-"`
}

func (*HTTPMetadata) GetRequest 

func (h *HTTPMetadata) GetRequest() *http.Request

func (*HTTPMetadata) GetResponse 

func (h *HTTPMetadata) GetResponse() *http.Response

type InvoiceCompensation 

type InvoiceCompensation struct {
	InvoiceID *string `json:"invoiceId,omitempty"`
}

func (*InvoiceCompensation) GetInvoiceID 

func (i *InvoiceCompensation) GetInvoiceID() *string

type InvoiceStatus 

type InvoiceStatus string

InvoiceStatus - Status of the invoice. 

const (
	InvoiceStatusOpen    InvoiceStatus = "open"
	InvoiceStatusPaid    InvoiceStatus = "paid"
	InvoiceStatusOverdue InvoiceStatus = "overdue"
)

func (InvoiceStatus) ToPointer 

func (e InvoiceStatus) ToPointer() *InvoiceStatus

type LineCategories added in v0.4.3 

type LineCategories string
const (
	LineCategoriesEco          LineCategories = "eco"
	LineCategoriesGift         LineCategories = "gift"
	LineCategoriesMeal         LineCategories = "meal"
	LineCategoriesSportCulture LineCategories = "sport_culture"
	LineCategoriesAdditional   LineCategories = "additional"
	LineCategoriesConsume      LineCategories = "consume"
)

func (LineCategories) ToPointer added in v0.4.3 

func (e LineCategories) ToPointer() *LineCategories

func (*LineCategories) UnmarshalJSON added in v0.4.3 

func (e *LineCategories) UnmarshalJSON(data []byte) error

type LineCategoriesResponse added in v0.4.3 

type LineCategoriesResponse string
const (
	LineCategoriesResponseEco          LineCategoriesResponse = "eco"
	LineCategoriesResponseGift         LineCategoriesResponse = "gift"
	LineCategoriesResponseMeal         LineCategoriesResponse = "meal"
	LineCategoriesResponseSportCulture LineCategoriesResponse = "sport_culture"
	LineCategoriesResponseAdditional   LineCategoriesResponse = "additional"
	LineCategoriesResponseConsume      LineCategoriesResponse = "consume"
)

func (LineCategoriesResponse) ToPointer added in v0.4.3 

func (e LineCategoriesResponse) ToPointer() *LineCategoriesResponse
type ListLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self URLObj `json:"self"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Previous *URLNullable `json:"previous"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Next *URLNullable `json:"next"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation URLObj `json:"documentation"`
}

ListLinks - Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field.

func (*ListLinks) GetDocumentation 

func (l *ListLinks) GetDocumentation() URLObj

func (*ListLinks) GetNext 

func (l *ListLinks) GetNext() *URLNullable

func (*ListLinks) GetPrevious 

func (l *ListLinks) GetPrevious() *URLNullable

func (*ListLinks) GetSelf 

func (l *ListLinks) GetSelf() URLObj

type ListSort 

type ListSort string
const (
	ListSortAsc  ListSort = "asc"
	ListSortDesc ListSort = "desc"
)

func (ListSort) ToPointer 

func (e ListSort) ToPointer() *ListSort

func (*ListSort) UnmarshalJSON 

func (e *ListSort) UnmarshalJSON(data []byte) error

type Locale 

type Locale string

Locale - Allows you to preset the language to be used. 

const (
	LocaleEnUs Locale = "en_US"
	LocaleEnGb Locale = "en_GB"
	LocaleNlNl Locale = "nl_NL"
	LocaleNlBe Locale = "nl_BE"
	LocaleDeDe Locale = "de_DE"
	LocaleDeAt Locale = "de_AT"
	LocaleDeCh Locale = "de_CH"
	LocaleFrFr Locale = "fr_FR"
	LocaleFrBe Locale = "fr_BE"
	LocaleEsEs Locale = "es_ES"
	LocaleCaEs Locale = "ca_ES"
	LocalePtPt Locale = "pt_PT"
	LocaleItIt Locale = "it_IT"
	LocaleNbNo Locale = "nb_NO"
	LocaleSvSe Locale = "sv_SE"
	LocaleFiFi Locale = "fi_FI"
	LocaleDaDk Locale = "da_DK"
	LocaleIsIs Locale = "is_IS"
	LocaleHuHu Locale = "hu_HU"
	LocalePlPl Locale = "pl_PL"
	LocaleLvLv Locale = "lv_LV"
	LocaleLtLt Locale = "lt_LT"
)

func (Locale) ToPointer 

func (e Locale) ToPointer() *Locale

func (*Locale) UnmarshalJSON 

func (e *Locale) UnmarshalJSON(data []byte) error

type LocaleParameter 

type LocaleParameter string
const (
	LocaleParameterEnUs LocaleParameter = "en_US"
	LocaleParameterEnGb LocaleParameter = "en_GB"
	LocaleParameterNlNl LocaleParameter = "nl_NL"
	LocaleParameterNlBe LocaleParameter = "nl_BE"
	LocaleParameterDeDe LocaleParameter = "de_DE"
	LocaleParameterDeAt LocaleParameter = "de_AT"
	LocaleParameterDeCh LocaleParameter = "de_CH"
	LocaleParameterFrFr LocaleParameter = "fr_FR"
	LocaleParameterFrBe LocaleParameter = "fr_BE"
	LocaleParameterEsEs LocaleParameter = "es_ES"
	LocaleParameterCaEs LocaleParameter = "ca_ES"
	LocaleParameterPtPt LocaleParameter = "pt_PT"
	LocaleParameterItIt LocaleParameter = "it_IT"
	LocaleParameterNbNo LocaleParameter = "nb_NO"
	LocaleParameterSvSe LocaleParameter = "sv_SE"
	LocaleParameterFiFi LocaleParameter = "fi_FI"
	LocaleParameterDaDk LocaleParameter = "da_DK"
	LocaleParameterIsIs LocaleParameter = "is_IS"
	LocaleParameterHuHu LocaleParameter = "hu_HU"
	LocaleParameterPlPl LocaleParameter = "pl_PL"
	LocaleParameterLvLv LocaleParameter = "lv_LV"
	LocaleParameterLtLt LocaleParameter = "lt_LT"
)

func (LocaleParameter) ToPointer 

func (e LocaleParameter) ToPointer() *LocaleParameter

func (*LocaleParameter) UnmarshalJSON 

func (e *LocaleParameter) UnmarshalJSON(data []byte) error

type LocaleResponse 

type LocaleResponse string

LocaleResponse - Allows you to preset the language to be used. 

const (
	LocaleResponseEnUs LocaleResponse = "en_US"
	LocaleResponseEnGb LocaleResponse = "en_GB"
	LocaleResponseNlNl LocaleResponse = "nl_NL"
	LocaleResponseNlBe LocaleResponse = "nl_BE"
	LocaleResponseDeDe LocaleResponse = "de_DE"
	LocaleResponseDeAt LocaleResponse = "de_AT"
	LocaleResponseDeCh LocaleResponse = "de_CH"
	LocaleResponseFrFr LocaleResponse = "fr_FR"
	LocaleResponseFrBe LocaleResponse = "fr_BE"
	LocaleResponseEsEs LocaleResponse = "es_ES"
	LocaleResponseCaEs LocaleResponse = "ca_ES"
	LocaleResponsePtPt LocaleResponse = "pt_PT"
	LocaleResponseItIt LocaleResponse = "it_IT"
	LocaleResponseNbNo LocaleResponse = "nb_NO"
	LocaleResponseSvSe LocaleResponse = "sv_SE"
	LocaleResponseFiFi LocaleResponse = "fi_FI"
	LocaleResponseDaDk LocaleResponse = "da_DK"
	LocaleResponseIsIs LocaleResponse = "is_IS"
	LocaleResponseHuHu LocaleResponse = "hu_HU"
	LocaleResponsePlPl LocaleResponse = "pl_PL"
	LocaleResponseLvLv LocaleResponse = "lv_LV"
	LocaleResponseLtLt LocaleResponse = "lt_LT"
)

func (LocaleResponse) ToPointer 

func (e LocaleResponse) ToPointer() *LocaleResponse

type ManagedFee 

type ManagedFee struct {
	FeeType *string `json:"feeType,omitempty"`
	FeeID   *string `json:"feeId,omitempty"`
}

func (*ManagedFee) GetFeeID 

func (m *ManagedFee) GetFeeID() *string

func (*ManagedFee) GetFeeType 

func (m *ManagedFee) GetFeeType() *string

type MandateDetailsCardLabelResponse 

type MandateDetailsCardLabelResponse string

MandateDetailsCardLabelResponse - The card's label. Available for card mandates, if the card label could be detected. 

const (
	MandateDetailsCardLabelResponseAmericanExpress MandateDetailsCardLabelResponse = "American Express"
	MandateDetailsCardLabelResponseCartaSi         MandateDetailsCardLabelResponse = "Carta Si"
	MandateDetailsCardLabelResponseCarteBleue      MandateDetailsCardLabelResponse = "Carte Bleue"
	MandateDetailsCardLabelResponseDankort         MandateDetailsCardLabelResponse = "Dankort"
	MandateDetailsCardLabelResponseDinersClub      MandateDetailsCardLabelResponse = "Diners Club"
	MandateDetailsCardLabelResponseDiscover        MandateDetailsCardLabelResponse = "Discover"
	MandateDetailsCardLabelResponseJcb             MandateDetailsCardLabelResponse = "JCB"
	MandateDetailsCardLabelResponseLaser           MandateDetailsCardLabelResponse = "Laser"
	MandateDetailsCardLabelResponseMaestro         MandateDetailsCardLabelResponse = "Maestro"
	MandateDetailsCardLabelResponseMastercard      MandateDetailsCardLabelResponse = "Mastercard"
	MandateDetailsCardLabelResponseUnionpay        MandateDetailsCardLabelResponse = "Unionpay"
	MandateDetailsCardLabelResponseVisa            MandateDetailsCardLabelResponse = "Visa"
)

func (MandateDetailsCardLabelResponse) ToPointer 

func (e MandateDetailsCardLabelResponse) ToPointer() *MandateDetailsCardLabelResponse

type MandateMethod 

type MandateMethod string

MandateMethod - Payment method of the mandate.

SEPA Direct Debit and PayPal mandates can be created directly. 

const (
	MandateMethodCreditcard  MandateMethod = "creditcard"
	MandateMethodDirectdebit MandateMethod = "directdebit"
	MandateMethodPaypal      MandateMethod = "paypal"
)

func (MandateMethod) ToPointer 

func (e MandateMethod) ToPointer() *MandateMethod

func (*MandateMethod) UnmarshalJSON 

func (e *MandateMethod) UnmarshalJSON(data []byte) error

type MandateMethodResponse 

type MandateMethodResponse string

MandateMethodResponse - Payment method of the mandate.

SEPA Direct Debit and PayPal mandates can be created directly. 

const (
	MandateMethodResponseCreditcard  MandateMethodResponse = "creditcard"
	MandateMethodResponseDirectdebit MandateMethodResponse = "directdebit"
	MandateMethodResponsePaypal      MandateMethodResponse = "paypal"
)

func (MandateMethodResponse) ToPointer 

func (e MandateMethodResponse) ToPointer() *MandateMethodResponse

type MandateResponse 

type MandateResponse struct {
	// Indicates the response contains a mandate object. Will always contain the string `mandate` for this endpoint.
	Resource *string `json:"resource,omitempty"`
	ID       *string `json:"id,omitempty"`
	// Whether this entity was created in live mode or in test mode.
	Mode *Mode `json:"mode,omitempty"`
	// Payment method of the mandate.
	//
	// SEPA Direct Debit and PayPal mandates can be created directly.
	Method  *MandateMethodResponse  `json:"method,omitempty"`
	Details *MandateResponseDetails `json:"details,omitempty"`
	// The date when the mandate was signed in `YYYY-MM-DD` format.
	SignatureDate *string `json:"signatureDate,omitempty"`
	// A custom mandate reference. For SEPA Direct Debit, it is vital to provide a unique reference. Some banks will
	// decline Direct Debit payments if the mandate reference is not unique.
	MandateReference *string `json:"mandateReference,omitempty"`
	// The status of the mandate. A status can be `pending` for mandates when the first payment is not yet finalized, or
	// when we did not received the IBAN yet from the first payment.
	Status     *MandateStatus `json:"status,omitempty"`
	CustomerID *string        `json:"customerId,omitempty"`
	// The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	CreatedAt *string `json:"createdAt,omitempty"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links *MandateResponseLinks `json:"_links,omitempty"`
}

func (*MandateResponse) GetCreatedAt 

func (m *MandateResponse) GetCreatedAt() *string

func (*MandateResponse) GetCustomerID 

func (m *MandateResponse) GetCustomerID() *string

func (*MandateResponse) GetDetails 

func (m *MandateResponse) GetDetails() *MandateResponseDetails

func (*MandateResponse) GetID 

func (m *MandateResponse) GetID() *string
func (m *MandateResponse) GetLinks() *MandateResponseLinks

func (*MandateResponse) GetMandateReference 

func (m *MandateResponse) GetMandateReference() *string

func (*MandateResponse) GetMethod 

func (m *MandateResponse) GetMethod() *MandateMethodResponse

func (*MandateResponse) GetMode 

func (m *MandateResponse) GetMode() *Mode

func (*MandateResponse) GetResource 

func (m *MandateResponse) GetResource() *string

func (*MandateResponse) GetSignatureDate 

func (m *MandateResponse) GetSignatureDate() *string

func (*MandateResponse) GetStatus 

func (m *MandateResponse) GetStatus() *MandateStatus

type MandateResponseDetails 

type MandateResponseDetails struct {
	// The customer's name. Available for SEPA Direct Debit and PayPal mandates.
	ConsumerName *string `json:"consumerName,omitempty"`
	// The customer's IBAN or email address. Available for SEPA Direct Debit and PayPal mandates.
	ConsumerAccount *string `json:"consumerAccount,omitempty"`
	// The BIC of the customer's bank. Available for SEPA Direct Debit mandates.
	ConsumerBic *string `json:"consumerBic,omitempty"`
	// The card holder's name. Available for card mandates.
	CardHolder *string `json:"cardHolder,omitempty"`
	// The last four digits of the card number. Available for card mandates.
	CardNumber *string `json:"cardNumber,omitempty"`
	// The card's expiry date in `YYYY-MM-DD` format. Available for card mandates.
	CardExpiryDate *string `json:"cardExpiryDate,omitempty"`
	// The card's label. Available for card mandates, if the card label could be detected.
	CardLabel *MandateDetailsCardLabelResponse `json:"cardLabel,omitempty"`
	// Unique alphanumeric representation of this specific card. Available for card mandates. Can be used to identify
	// returning customers.
	CardFingerprint *string `json:"cardFingerprint,omitempty"`
}

func (*MandateResponseDetails) GetCardExpiryDate 

func (m *MandateResponseDetails) GetCardExpiryDate() *string

func (*MandateResponseDetails) GetCardFingerprint 

func (m *MandateResponseDetails) GetCardFingerprint() *string

func (*MandateResponseDetails) GetCardHolder 

func (m *MandateResponseDetails) GetCardHolder() *string

func (*MandateResponseDetails) GetCardLabel 

func (m *MandateResponseDetails) GetCardLabel() *MandateDetailsCardLabelResponse

func (*MandateResponseDetails) GetCardNumber 

func (m *MandateResponseDetails) GetCardNumber() *string

func (*MandateResponseDetails) GetConsumerAccount 

func (m *MandateResponseDetails) GetConsumerAccount() *string

func (*MandateResponseDetails) GetConsumerBic 

func (m *MandateResponseDetails) GetConsumerBic() *string

func (*MandateResponseDetails) GetConsumerName 

func (m *MandateResponseDetails) GetConsumerName() *string
type MandateResponseLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self URLObj `json:"self"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Customer URLObj `json:"customer"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation URLObj `json:"documentation"`
}

MandateResponseLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.

func (*MandateResponseLinks) GetCustomer 

func (m *MandateResponseLinks) GetCustomer() URLObj

func (*MandateResponseLinks) GetDocumentation 

func (m *MandateResponseLinks) GetDocumentation() URLObj

func (*MandateResponseLinks) GetSelf 

func (m *MandateResponseLinks) GetSelf() URLObj

type MandateStatus 

type MandateStatus string

MandateStatus - The status of the mandate. A status can be `pending` for mandates when the first payment is not yet finalized, or when we did not received the IBAN yet from the first payment. 

const (
	MandateStatusValid   MandateStatus = "valid"
	MandateStatusPending MandateStatus = "pending"
	MandateStatusInvalid MandateStatus = "invalid"
)

func (MandateStatus) ToPointer 

func (e MandateStatus) ToPointer() *MandateStatus

type Metadata 

type Metadata struct {
	Str        *string        `queryParam:"inline,name=metadata"`
	MapOfAny   map[string]any `queryParam:"inline,name=metadata"`
	ArrayOfStr []string       `queryParam:"inline,name=metadata"`

	Type MetadataType
}

Metadata - Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.

func CreateMetadataArrayOfStr 

func CreateMetadataArrayOfStr(arrayOfStr []string) Metadata

func CreateMetadataMapOfAny 

func CreateMetadataMapOfAny(mapOfAny map[string]any) Metadata

func CreateMetadataStr 

func CreateMetadataStr(str string) Metadata

func (Metadata) MarshalJSON 

func (u Metadata) MarshalJSON() ([]byte, error)

func (*Metadata) UnmarshalJSON 

func (u *Metadata) UnmarshalJSON(data []byte) error

type MetadataType 

type MetadataType string
const (
	MetadataTypeStr        MetadataType = "str"
	MetadataTypeMapOfAny   MetadataType = "mapOfAny"
	MetadataTypeArrayOfStr MetadataType = "arrayOfStr"
)

type Method 

type Method string

Method - Normally, a payment method screen is shown. However, when using this parameter, you can choose a specific payment method and your customer will skip the selection screen and is sent directly to the chosen payment method. The parameter enables you to fully integrate the payment method selection into your website.

You can also specify the methods in an array. By doing so we will still show the payment method selection screen but will only show the methods specified in the array. For example, you can use this functionality to only show payment methods from a specific country to your customer `['bancontact', 'belfius']`. 

const (
	MethodAlma           Method = "alma"
	MethodApplepay       Method = "applepay"
	MethodBacs           Method = "bacs"
	MethodBancomatpay    Method = "bancomatpay"
	MethodBancontact     Method = "bancontact"
	MethodBanktransfer   Method = "banktransfer"
	MethodBelfius        Method = "belfius"
	MethodBillie         Method = "billie"
	MethodBizum          Method = "bizum"
	MethodBlik           Method = "blik"
	MethodCreditcard     Method = "creditcard"
	MethodDirectdebit    Method = "directdebit"
	MethodEps            Method = "eps"
	MethodGiftcard       Method = "giftcard"
	MethodIdeal          Method = "ideal"
	MethodIn3            Method = "in3"
	MethodKbc            Method = "kbc"
	MethodKlarna         Method = "klarna"
	MethodKlarnapaylater Method = "klarnapaylater"
	MethodKlarnapaynow   Method = "klarnapaynow"
	MethodKlarnasliceit  Method = "klarnasliceit"
	MethodMbway          Method = "mbway"
	MethodMultibanco     Method = "multibanco"
	MethodMybank         Method = "mybank"
	MethodPaybybank      Method = "paybybank"
	MethodPayconiq       Method = "payconiq"
	MethodPaypal         Method = "paypal"
	MethodPaysafecard    Method = "paysafecard"
	MethodPointofsale    Method = "pointofsale"
	MethodPrzelewy24     Method = "przelewy24"
	MethodRiverty        Method = "riverty"
	MethodSatispay       Method = "satispay"
	MethodSwish          Method = "swish"
	MethodTrustly        Method = "trustly"
	MethodTwint          Method = "twint"
	MethodVoucher        Method = "voucher"
)

func (Method) ToPointer 

func (e Method) ToPointer() *Method

func (*Method) UnmarshalJSON 

func (e *Method) UnmarshalJSON(data []byte) error

type MethodResponse 

type MethodResponse string

MethodResponse - Normally, a payment method screen is shown. However, when using this parameter, you can choose a specific payment method and your customer will skip the selection screen and is sent directly to the chosen payment method. The parameter enables you to fully integrate the payment method selection into your website.

You can also specify the methods in an array. By doing so we will still show the payment method selection screen but will only show the methods specified in the array. For example, you can use this functionality to only show payment methods from a specific country to your customer `['bancontact', 'belfius']`. 

const (
	MethodResponseAlma           MethodResponse = "alma"
	MethodResponseApplepay       MethodResponse = "applepay"
	MethodResponseBacs           MethodResponse = "bacs"
	MethodResponseBancomatpay    MethodResponse = "bancomatpay"
	MethodResponseBancontact     MethodResponse = "bancontact"
	MethodResponseBanktransfer   MethodResponse = "banktransfer"
	MethodResponseBelfius        MethodResponse = "belfius"
	MethodResponseBillie         MethodResponse = "billie"
	MethodResponseBizum          MethodResponse = "bizum"
	MethodResponseBlik           MethodResponse = "blik"
	MethodResponseCreditcard     MethodResponse = "creditcard"
	MethodResponseDirectdebit    MethodResponse = "directdebit"
	MethodResponseEps            MethodResponse = "eps"
	MethodResponseGiftcard       MethodResponse = "giftcard"
	MethodResponseIdeal          MethodResponse = "ideal"
	MethodResponseIn3            MethodResponse = "in3"
	MethodResponseKbc            MethodResponse = "kbc"
	MethodResponseKlarna         MethodResponse = "klarna"
	MethodResponseKlarnapaylater MethodResponse = "klarnapaylater"
	MethodResponseKlarnapaynow   MethodResponse = "klarnapaynow"
	MethodResponseKlarnasliceit  MethodResponse = "klarnasliceit"
	MethodResponseMbway          MethodResponse = "mbway"
	MethodResponseMultibanco     MethodResponse = "multibanco"
	MethodResponseMybank         MethodResponse = "mybank"
	MethodResponsePaybybank      MethodResponse = "paybybank"
	MethodResponsePayconiq       MethodResponse = "payconiq"
	MethodResponsePaypal         MethodResponse = "paypal"
	MethodResponsePaysafecard    MethodResponse = "paysafecard"
	MethodResponsePointofsale    MethodResponse = "pointofsale"
	MethodResponsePrzelewy24     MethodResponse = "przelewy24"
	MethodResponseRiverty        MethodResponse = "riverty"
	MethodResponseSatispay       MethodResponse = "satispay"
	MethodResponseSwish          MethodResponse = "swish"
	MethodResponseTrustly        MethodResponse = "trustly"
	MethodResponseTwint          MethodResponse = "twint"
	MethodResponseVoucher        MethodResponse = "voucher"
)

func (MethodResponse) ToPointer 

func (e MethodResponse) ToPointer() *MethodResponse

type MethodStatus 

type MethodStatus string

MethodStatus - The payment method's activation status for this profile. 

const (
	MethodStatusActivated       MethodStatus = "activated"
	MethodStatusPendingBoarding MethodStatus = "pending-boarding"
	MethodStatusPendingReview   MethodStatus = "pending-review"
	MethodStatusPendingExternal MethodStatus = "pending-external"
	MethodStatusRejected        MethodStatus = "rejected"
)

func (MethodStatus) ToPointer 

func (e MethodStatus) ToPointer() *MethodStatus

type Mode 

type Mode string

Mode - Whether this entity was created in live mode or in test mode. 

const (
	ModeLive Mode = "live"
	ModeTest Mode = "test"
)

func (Mode) ToPointer 

func (e Mode) ToPointer() *Mode

type OnboardingStatus 

type OnboardingStatus string

OnboardingStatus - The current status of the organization's onboarding process. 

const (
	OnboardingStatusNeedsData OnboardingStatus = "needs-data"
	OnboardingStatusInReview  OnboardingStatus = "in-review"
	OnboardingStatusCompleted OnboardingStatus = "completed"
)

func (OnboardingStatus) ToPointer 

func (e OnboardingStatus) ToPointer() *OnboardingStatus

type Open 

type Open struct {
	Pending   *SubGroup `json:"pending,omitempty"`
	Available *SubGroup `json:"available,omitempty"`
}

Open - Only available on `transaction-categories` grouping.

func (*Open) GetAvailable 

func (o *Open) GetAvailable() *SubGroup

func (*Open) GetPending 

func (o *Open) GetPending() *SubGroup

type OrganizationVatRegulation 

type OrganizationVatRegulation string

OrganizationVatRegulation - Mollie applies Dutch VAT for merchants based in The Netherlands, British VAT for merchants based in The United Kingdom, and shifted VAT for merchants in the European Union.

The field is not present for merchants residing in other countries. 

const (
	OrganizationVatRegulationDutch   OrganizationVatRegulation = "dutch"
	OrganizationVatRegulationBritish OrganizationVatRegulation = "british"
	OrganizationVatRegulationShifted OrganizationVatRegulation = "shifted"
)

func (OrganizationVatRegulation) ToPointer 

func (e OrganizationVatRegulation) ToPointer() *OrganizationVatRegulation

type OutgoingTransfer 

type OutgoingTransfer struct {
	TransferID   *string `json:"transferId,omitempty"`
	SettlementID *string `json:"settlementId,omitempty"`
}

func (*OutgoingTransfer) GetSettlementID 

func (o *OutgoingTransfer) GetSettlementID() *string

func (*OutgoingTransfer) GetTransferID 

func (o *OutgoingTransfer) GetTransferID() *string

type Owner 

type Owner struct {
	// The email address of your customer.
	Email string `json:"email"`
	// The given name (first name) of your customer.
	GivenName string `json:"givenName"`
	// The family name (surname) of your customer.
	FamilyName string `json:"familyName"`
	// Allows you to preset the language to be used.
	Locale *LocaleResponse `json:"locale,omitempty"`
}

Owner - Personal data of your customer.

func (*Owner) GetEmail 

func (o *Owner) GetEmail() string

func (*Owner) GetFamilyName 

func (o *Owner) GetFamilyName() string

func (*Owner) GetGivenName 

func (o *Owner) GetGivenName() string

func (*Owner) GetLocale 

func (o *Owner) GetLocale() *LocaleResponse

type Payment 

type Payment struct {
	PaymentID          *string `json:"paymentId,omitempty"`
	PaymentDescription *string `json:"paymentDescription,omitempty"`
}

func (*Payment) GetPaymentDescription 

func (p *Payment) GetPaymentDescription() *string

func (*Payment) GetPaymentID 

func (p *Payment) GetPaymentID() *string

type PaymentAddress 

type PaymentAddress struct {
	// The title of the person, for example *Mr.* or *Mrs.*.
	Title *string `json:"title,omitempty"`
	// The given name (first name) of the person should be at least two characters and cannot contain only
	// numbers.
	//
	// Required for payment methods `billie`, `in3`, `klarna` and `riverty`.
	GivenName *string `json:"givenName,omitempty"`
	// The given family name (surname) of the person should be at least two characters and cannot contain only
	// numbers.
	//
	// Required for payment methods `billie`, `in3`, `klarna` and `riverty`.
	FamilyName *string `json:"familyName,omitempty"`
	// The name of the organization, in case the addressee is an organization.
	OrganizationName *string `json:"organizationName,omitempty"`
	// A street and street number.
	//
	// Required for payment methods `billie`, `in3`, `klarna` and `riverty`.
	StreetAndNumber *string `json:"streetAndNumber,omitempty"`
	// Any additional addressing details, for example an apartment number.
	StreetAdditional *string `json:"streetAdditional,omitempty"`
	// A postal code. This field may be required if the provided country has a postal code system.
	//
	// Required for payment methods `billie`, `in3`, `klarna` and `riverty`.
	PostalCode *string `json:"postalCode,omitempty"`
	// A valid e-mail address.
	//
	// If you provide the email address for a `banktransfer` payment, we will automatically send the instructions
	// email upon payment creation. The language of the email will follow the locale parameter of the payment.
	//
	// Required for payment methods `billie`, `in3`, `klarna` and `riverty`.
	Email *string `json:"email,omitempty"`
	// If provided, it must be in the [E.164](https://en.wikipedia.org/wiki/E.164) format. For example: +31208202070.
	Phone *string `json:"phone,omitempty"`
	// A city name.
	//
	// Required for payment methods `billie`, `in3`, `klarna` and `riverty`.
	City *string `json:"city,omitempty"`
	// The top-level administrative subdivision of the country. For example: Noord-Holland.
	Region *string `json:"region,omitempty"`
	// A country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
	//
	// Required for payment methods `billie`, `in3`, `klarna` and `riverty`.
	Country *string `json:"country,omitempty"`
}

func (*PaymentAddress) GetCity 

func (p *PaymentAddress) GetCity() *string

func (*PaymentAddress) GetCountry 

func (p *PaymentAddress) GetCountry() *string

func (*PaymentAddress) GetEmail 

func (p *PaymentAddress) GetEmail() *string

func (*PaymentAddress) GetFamilyName 

func (p *PaymentAddress) GetFamilyName() *string

func (*PaymentAddress) GetGivenName 

func (p *PaymentAddress) GetGivenName() *string

func (*PaymentAddress) GetOrganizationName 

func (p *PaymentAddress) GetOrganizationName() *string

func (*PaymentAddress) GetPhone 

func (p *PaymentAddress) GetPhone() *string

func (*PaymentAddress) GetPostalCode 

func (p *PaymentAddress) GetPostalCode() *string

func (*PaymentAddress) GetRegion 

func (p *PaymentAddress) GetRegion() *string

func (*PaymentAddress) GetStreetAdditional 

func (p *PaymentAddress) GetStreetAdditional() *string

func (*PaymentAddress) GetStreetAndNumber 

func (p *PaymentAddress) GetStreetAndNumber() *string

func (*PaymentAddress) GetTitle 

func (p *PaymentAddress) GetTitle() *string

func (PaymentAddress) MarshalJSON 

func (p PaymentAddress) MarshalJSON() ([]byte, error)

func (*PaymentAddress) UnmarshalJSON 

func (p *PaymentAddress) UnmarshalJSON(data []byte) error

type PaymentCommission 

type PaymentCommission struct {
	PaymentID          *string `json:"paymentId,omitempty"`
	PaymentDescription *string `json:"paymentDescription,omitempty"`
	OrganizationID     *string `json:"organizationId,omitempty"`
}

func (*PaymentCommission) GetOrganizationID 

func (p *PaymentCommission) GetOrganizationID() *string

func (*PaymentCommission) GetPaymentDescription 

func (p *PaymentCommission) GetPaymentDescription() *string

func (*PaymentCommission) GetPaymentID 

func (p *PaymentCommission) GetPaymentID() *string

type PaymentDetailsCardAuditionResponse 

type PaymentDetailsCardAuditionResponse string

PaymentDetailsCardAuditionResponse - The card's target audience, if known. 

const (
	PaymentDetailsCardAuditionResponseConsumer PaymentDetailsCardAuditionResponse = "consumer"
	PaymentDetailsCardAuditionResponseBusiness PaymentDetailsCardAuditionResponse = "business"
)

func (PaymentDetailsCardAuditionResponse) ToPointer 

func (e PaymentDetailsCardAuditionResponse) ToPointer() *PaymentDetailsCardAuditionResponse

type PaymentDetailsCardFundingResponse 

type PaymentDetailsCardFundingResponse string

PaymentDetailsCardFundingResponse - The card type. 

const (
	PaymentDetailsCardFundingResponseDebit         PaymentDetailsCardFundingResponse = "debit"
	PaymentDetailsCardFundingResponseCredit        PaymentDetailsCardFundingResponse = "credit"
	PaymentDetailsCardFundingResponsePrepaid       PaymentDetailsCardFundingResponse = "prepaid"
	PaymentDetailsCardFundingResponseDeferredDebit PaymentDetailsCardFundingResponse = "deferred-debit"
)

func (PaymentDetailsCardFundingResponse) ToPointer 

func (e PaymentDetailsCardFundingResponse) ToPointer() *PaymentDetailsCardFundingResponse

type PaymentDetailsCardLabelResponse 

type PaymentDetailsCardLabelResponse string

PaymentDetailsCardLabelResponse - The card's label, if known. 

const (
	PaymentDetailsCardLabelResponseAmericanExpress PaymentDetailsCardLabelResponse = "American Express"
	PaymentDetailsCardLabelResponseCartaSi         PaymentDetailsCardLabelResponse = "Carta Si"
	PaymentDetailsCardLabelResponseCarteBleue      PaymentDetailsCardLabelResponse = "Carte Bleue"
	PaymentDetailsCardLabelResponseDankort         PaymentDetailsCardLabelResponse = "Dankort"
	PaymentDetailsCardLabelResponseDinersClub      PaymentDetailsCardLabelResponse = "Diners Club"
	PaymentDetailsCardLabelResponseDiscover        PaymentDetailsCardLabelResponse = "Discover"
	PaymentDetailsCardLabelResponseJcb             PaymentDetailsCardLabelResponse = "JCB"
	PaymentDetailsCardLabelResponseLaser           PaymentDetailsCardLabelResponse = "Laser"
	PaymentDetailsCardLabelResponseMaestro         PaymentDetailsCardLabelResponse = "Maestro"
	PaymentDetailsCardLabelResponseMastercard      PaymentDetailsCardLabelResponse = "Mastercard"
	PaymentDetailsCardLabelResponseUnionpay        PaymentDetailsCardLabelResponse = "Unionpay"
	PaymentDetailsCardLabelResponseVisa            PaymentDetailsCardLabelResponse = "Visa"
	PaymentDetailsCardLabelResponseVpay            PaymentDetailsCardLabelResponse = "Vpay"
)

func (PaymentDetailsCardLabelResponse) ToPointer 

func (e PaymentDetailsCardLabelResponse) ToPointer() *PaymentDetailsCardLabelResponse

type PaymentDetailsCardSecurityResponse 

type PaymentDetailsCardSecurityResponse string

PaymentDetailsCardSecurityResponse - The level of security applied during card processing. 

const (
	PaymentDetailsCardSecurityResponseNormal       PaymentDetailsCardSecurityResponse = "normal"
	PaymentDetailsCardSecurityResponseThreedsecure PaymentDetailsCardSecurityResponse = "3dsecure"
)

func (PaymentDetailsCardSecurityResponse) ToPointer 

func (e PaymentDetailsCardSecurityResponse) ToPointer() *PaymentDetailsCardSecurityResponse

type PaymentDetailsFailureReasonResponse 

type PaymentDetailsFailureReasonResponse string

PaymentDetailsFailureReasonResponse - A failure code to help understand why the payment failed. 

const (
	PaymentDetailsFailureReasonResponseAuthenticationAbandoned      PaymentDetailsFailureReasonResponse = "authentication_abandoned"
	PaymentDetailsFailureReasonResponseAuthenticationFailed         PaymentDetailsFailureReasonResponse = "authentication_failed"
	PaymentDetailsFailureReasonResponseAuthenticationRequired       PaymentDetailsFailureReasonResponse = "authentication_required"
	PaymentDetailsFailureReasonResponseAuthenticationUnavailableAcs PaymentDetailsFailureReasonResponse = "authentication_unavailable_acs"
	PaymentDetailsFailureReasonResponseCardDeclined                 PaymentDetailsFailureReasonResponse = "card_declined"
	PaymentDetailsFailureReasonResponseCardExpired                  PaymentDetailsFailureReasonResponse = "card_expired"
	PaymentDetailsFailureReasonResponseInactiveCard                 PaymentDetailsFailureReasonResponse = "inactive_card"
	PaymentDetailsFailureReasonResponseInsufficientFunds            PaymentDetailsFailureReasonResponse = "insufficient_funds"
	PaymentDetailsFailureReasonResponseInvalidCvv                   PaymentDetailsFailureReasonResponse = "invalid_cvv"
	PaymentDetailsFailureReasonResponseInvalidCardHolderName        PaymentDetailsFailureReasonResponse = "invalid_card_holder_name"
	PaymentDetailsFailureReasonResponseInvalidCardNumber            PaymentDetailsFailureReasonResponse = "invalid_card_number"
	PaymentDetailsFailureReasonResponseInvalidCardType              PaymentDetailsFailureReasonResponse = "invalid_card_type"
	PaymentDetailsFailureReasonResponsePossibleFraud                PaymentDetailsFailureReasonResponse = "possible_fraud"
	PaymentDetailsFailureReasonResponseRefusedByIssuer              PaymentDetailsFailureReasonResponse = "refused_by_issuer"
	PaymentDetailsFailureReasonResponseUnknownReason                PaymentDetailsFailureReasonResponse = "unknown_reason"
)

func (PaymentDetailsFailureReasonResponse) ToPointer 

func (e PaymentDetailsFailureReasonResponse) ToPointer() *PaymentDetailsFailureReasonResponse

type PaymentDetailsFeeRegionResponse 

type PaymentDetailsFeeRegionResponse string

PaymentDetailsFeeRegionResponse - The applicable card fee region. 

const (
	PaymentDetailsFeeRegionResponseAmericanExpress  PaymentDetailsFeeRegionResponse = "american-express"
	PaymentDetailsFeeRegionResponseAmexIntraEea     PaymentDetailsFeeRegionResponse = "amex-intra-eea"
	PaymentDetailsFeeRegionResponseCarteBancaire    PaymentDetailsFeeRegionResponse = "carte-bancaire"
	PaymentDetailsFeeRegionResponseIntraEu          PaymentDetailsFeeRegionResponse = "intra-eu"
	PaymentDetailsFeeRegionResponseIntraEuCorporate PaymentDetailsFeeRegionResponse = "intra-eu-corporate"
	PaymentDetailsFeeRegionResponseDomestic         PaymentDetailsFeeRegionResponse = "domestic"
	PaymentDetailsFeeRegionResponseMaestro          PaymentDetailsFeeRegionResponse = "maestro"
	PaymentDetailsFeeRegionResponseOther            PaymentDetailsFeeRegionResponse = "other"
	PaymentDetailsFeeRegionResponseInter            PaymentDetailsFeeRegionResponse = "inter"
	PaymentDetailsFeeRegionResponseIntraEea         PaymentDetailsFeeRegionResponse = "intra_eea"
)

func (PaymentDetailsFeeRegionResponse) ToPointer 

func (e PaymentDetailsFeeRegionResponse) ToPointer() *PaymentDetailsFeeRegionResponse

type PaymentDetailsReceiptCardReadMethodResponse 

type PaymentDetailsReceiptCardReadMethodResponse string

PaymentDetailsReceiptCardReadMethodResponse - The method by which the card was read by the terminal. 

const (
	PaymentDetailsReceiptCardReadMethodResponseChip                   PaymentDetailsReceiptCardReadMethodResponse = "chip"
	PaymentDetailsReceiptCardReadMethodResponseMagneticStripe         PaymentDetailsReceiptCardReadMethodResponse = "magnetic-stripe"
	PaymentDetailsReceiptCardReadMethodResponseNearFieldCommunication PaymentDetailsReceiptCardReadMethodResponse = "near-field-communication"
	PaymentDetailsReceiptCardReadMethodResponseContactless            PaymentDetailsReceiptCardReadMethodResponse = "contactless"
	PaymentDetailsReceiptCardReadMethodResponseMoto                   PaymentDetailsReceiptCardReadMethodResponse = "moto"
)

func (PaymentDetailsReceiptCardReadMethodResponse) ToPointer 

func (e PaymentDetailsReceiptCardReadMethodResponse) ToPointer() *PaymentDetailsReceiptCardReadMethodResponse

type PaymentDetailsReceiptCardVerificationMethodResponse 

type PaymentDetailsReceiptCardVerificationMethodResponse string

PaymentDetailsReceiptCardVerificationMethodResponse - The method used to verify the cardholder's identity. 

const (
	PaymentDetailsReceiptCardVerificationMethodResponseNoCvmRequired         PaymentDetailsReceiptCardVerificationMethodResponse = "no-cvm-required"
	PaymentDetailsReceiptCardVerificationMethodResponseOnlinePin             PaymentDetailsReceiptCardVerificationMethodResponse = "online-pin"
	PaymentDetailsReceiptCardVerificationMethodResponseOfflinePin            PaymentDetailsReceiptCardVerificationMethodResponse = "offline-pin"
	PaymentDetailsReceiptCardVerificationMethodResponseConsumerDevice        PaymentDetailsReceiptCardVerificationMethodResponse = "consumer-device"
	PaymentDetailsReceiptCardVerificationMethodResponseSignature             PaymentDetailsReceiptCardVerificationMethodResponse = "signature"
	PaymentDetailsReceiptCardVerificationMethodResponseSignatureAndOnlinePin PaymentDetailsReceiptCardVerificationMethodResponse = "signature-and-online-pin"
	PaymentDetailsReceiptCardVerificationMethodResponseOnlinePinAndSignature PaymentDetailsReceiptCardVerificationMethodResponse = "online-pin-and-signature"
	PaymentDetailsReceiptCardVerificationMethodResponseNone                  PaymentDetailsReceiptCardVerificationMethodResponse = "none"
	PaymentDetailsReceiptCardVerificationMethodResponseFailed                PaymentDetailsReceiptCardVerificationMethodResponse = "failed"
)

func (PaymentDetailsReceiptCardVerificationMethodResponse) ToPointer 

func (e PaymentDetailsReceiptCardVerificationMethodResponse) ToPointer() *PaymentDetailsReceiptCardVerificationMethodResponse

type PaymentDetailsSellerProtectionResponse 

type PaymentDetailsSellerProtectionResponse string

PaymentDetailsSellerProtectionResponse - Indicates to what extent the payment is eligible for PayPal's Seller Protection. Only available for PayPal payments, and if the information is made available by PayPal. 

const (
	PaymentDetailsSellerProtectionResponseEligible                          PaymentDetailsSellerProtectionResponse = "Eligible"
	PaymentDetailsSellerProtectionResponseIneligible                        PaymentDetailsSellerProtectionResponse = "Ineligible"
	PaymentDetailsSellerProtectionResponsePartiallyEligibleInrOnly          PaymentDetailsSellerProtectionResponse = "Partially Eligible - INR Only"
	PaymentDetailsSellerProtectionResponsePartiallyEligibleUnauthOnly       PaymentDetailsSellerProtectionResponse = "Partially Eligible - Unauth Only"
	PaymentDetailsSellerProtectionResponsePartiallyEligible                 PaymentDetailsSellerProtectionResponse = "Partially Eligible"
	PaymentDetailsSellerProtectionResponseNone                              PaymentDetailsSellerProtectionResponse = "None"
	PaymentDetailsSellerProtectionResponseActive                            PaymentDetailsSellerProtectionResponse = "Active"
	PaymentDetailsSellerProtectionResponseFraudControlUnauthPremiumEligible PaymentDetailsSellerProtectionResponse = "Fraud Control - Unauth Premium Eligible"
)

func (PaymentDetailsSellerProtectionResponse) ToPointer 

func (e PaymentDetailsSellerProtectionResponse) ToPointer() *PaymentDetailsSellerProtectionResponse

type PaymentDetailsWalletResponse 

type PaymentDetailsWalletResponse string

PaymentDetailsWalletResponse - The wallet used when creating the payment. 

const (
	PaymentDetailsWalletResponseApplepay PaymentDetailsWalletResponse = "applepay"
)

func (PaymentDetailsWalletResponse) ToPointer 

func (e PaymentDetailsWalletResponse) ToPointer() *PaymentDetailsWalletResponse

type PaymentFee 

type PaymentFee struct {
	PaymentID          *string `json:"paymentId,omitempty"`
	PaymentDescription *string `json:"paymentDescription,omitempty"`
}

func (*PaymentFee) GetPaymentDescription 

func (p *PaymentFee) GetPaymentDescription() *string

func (*PaymentFee) GetPaymentID 

func (p *PaymentFee) GetPaymentID() *string

type PaymentLineItem 

type PaymentLineItem struct {
	// The type of product purchased. For example, a physical or a digital product.
	//
	// The `tip` payment line type is not available when creating a payment.
	Type *PaymentLineType `json:"type,omitempty"`
	// A description of the line item. For example *LEGO 4440 Forest Police Station*.
	Description string `json:"description"`
	// The number of items.
	Quantity int64 `json:"quantity"`
	// The unit for the quantity. For example *pcs*, *kg*, or *cm*.
	QuantityUnit *string `json:"quantityUnit,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	UnitPrice Amount `json:"unitPrice"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	DiscountAmount *Amount `json:"discountAmount,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	TotalAmount Amount `json:"totalAmount"`
	// The VAT rate applied to the line, for example `21.00` for 21%. The vatRate should be passed as a string and
	// not as a float, to ensure the correct number of decimals are passed.
	VatRate *string `json:"vatRate,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	VatAmount *Amount `json:"vatAmount,omitempty"`
	// The SKU, EAN, ISBN or UPC of the product sold.
	Sku *string `json:"sku,omitempty"`
	// An array with the voucher categories, in case of a line eligible for a voucher. See the
	// [Integrating Vouchers](https://docs.mollie.com/docs/integrating-vouchers/) guide for more information.
	Categories []LineCategories `json:"categories,omitempty"`
	// A link pointing to an image of the product sold.
	ImageURL *string `json:"imageUrl,omitempty"`
	// A link pointing to the product page in your web shop of the product sold.
	ProductURL *string `json:"productUrl,omitempty"`
}

func (*PaymentLineItem) GetCategories 

func (p *PaymentLineItem) GetCategories() []LineCategories

func (*PaymentLineItem) GetDescription 

func (p *PaymentLineItem) GetDescription() string

func (*PaymentLineItem) GetDiscountAmount 

func (p *PaymentLineItem) GetDiscountAmount() *Amount

func (*PaymentLineItem) GetImageURL 

func (p *PaymentLineItem) GetImageURL() *string

func (*PaymentLineItem) GetProductURL 

func (p *PaymentLineItem) GetProductURL() *string

func (*PaymentLineItem) GetQuantity 

func (p *PaymentLineItem) GetQuantity() int64

func (*PaymentLineItem) GetQuantityUnit 

func (p *PaymentLineItem) GetQuantityUnit() *string

func (*PaymentLineItem) GetSku 

func (p *PaymentLineItem) GetSku() *string

func (*PaymentLineItem) GetTotalAmount 

func (p *PaymentLineItem) GetTotalAmount() Amount

func (*PaymentLineItem) GetType 

func (p *PaymentLineItem) GetType() *PaymentLineType

func (*PaymentLineItem) GetUnitPrice 

func (p *PaymentLineItem) GetUnitPrice() Amount

func (*PaymentLineItem) GetVatAmount 

func (p *PaymentLineItem) GetVatAmount() *Amount

func (*PaymentLineItem) GetVatRate 

func (p *PaymentLineItem) GetVatRate() *string

type PaymentLineItemResponse 

type PaymentLineItemResponse struct {
	// The type of product purchased. For example, a physical or a digital product.
	//
	// The `tip` payment line type is not available when creating a payment.
	Type *PaymentLineTypeResponse `json:"type,omitempty"`
	// A description of the line item. For example *LEGO 4440 Forest Police Station*.
	Description string `json:"description"`
	// The number of items.
	Quantity int64 `json:"quantity"`
	// The unit for the quantity. For example *pcs*, *kg*, or *cm*.
	QuantityUnit *string `json:"quantityUnit,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	UnitPrice Amount `json:"unitPrice"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	DiscountAmount *Amount `json:"discountAmount,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	TotalAmount Amount `json:"totalAmount"`
	// The VAT rate applied to the line, for example `21.00` for 21%. The vatRate should be passed as a string and
	// not as a float, to ensure the correct number of decimals are passed.
	VatRate *string `json:"vatRate,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	VatAmount *Amount `json:"vatAmount,omitempty"`
	// The SKU, EAN, ISBN or UPC of the product sold.
	Sku *string `json:"sku,omitempty"`
	// An array with the voucher categories, in case of a line eligible for a voucher. See the
	// [Integrating Vouchers](https://docs.mollie.com/docs/integrating-vouchers/) guide for more information.
	Categories []LineCategoriesResponse `json:"categories,omitempty"`
	// A link pointing to an image of the product sold.
	ImageURL *string `json:"imageUrl,omitempty"`
	// A link pointing to the product page in your web shop of the product sold.
	ProductURL *string `json:"productUrl,omitempty"`
}

func (*PaymentLineItemResponse) GetCategories 

func (p *PaymentLineItemResponse) GetCategories() []LineCategoriesResponse

func (*PaymentLineItemResponse) GetDescription 

func (p *PaymentLineItemResponse) GetDescription() string

func (*PaymentLineItemResponse) GetDiscountAmount 

func (p *PaymentLineItemResponse) GetDiscountAmount() *Amount

func (*PaymentLineItemResponse) GetImageURL 

func (p *PaymentLineItemResponse) GetImageURL() *string

func (*PaymentLineItemResponse) GetProductURL 

func (p *PaymentLineItemResponse) GetProductURL() *string

func (*PaymentLineItemResponse) GetQuantity 

func (p *PaymentLineItemResponse) GetQuantity() int64

func (*PaymentLineItemResponse) GetQuantityUnit 

func (p *PaymentLineItemResponse) GetQuantityUnit() *string

func (*PaymentLineItemResponse) GetSku 

func (p *PaymentLineItemResponse) GetSku() *string

func (*PaymentLineItemResponse) GetTotalAmount 

func (p *PaymentLineItemResponse) GetTotalAmount() Amount

func (*PaymentLineItemResponse) GetType 

func (p *PaymentLineItemResponse) GetType() *PaymentLineTypeResponse

func (*PaymentLineItemResponse) GetUnitPrice 

func (p *PaymentLineItemResponse) GetUnitPrice() Amount

func (*PaymentLineItemResponse) GetVatAmount 

func (p *PaymentLineItemResponse) GetVatAmount() *Amount

func (*PaymentLineItemResponse) GetVatRate 

func (p *PaymentLineItemResponse) GetVatRate() *string

func (PaymentLineItemResponse) MarshalJSON 

func (p PaymentLineItemResponse) MarshalJSON() ([]byte, error)

func (*PaymentLineItemResponse) UnmarshalJSON 

func (p *PaymentLineItemResponse) UnmarshalJSON(data []byte) error

type PaymentLineType 

type PaymentLineType string

PaymentLineType - The type of product purchased. For example, a physical or a digital product.

The `tip` payment line type is not available when creating a payment. 

const (
	PaymentLineTypePhysical    PaymentLineType = "physical"
	PaymentLineTypeDigital     PaymentLineType = "digital"
	PaymentLineTypeShippingFee PaymentLineType = "shipping_fee"
	PaymentLineTypeDiscount    PaymentLineType = "discount"
	PaymentLineTypeStoreCredit PaymentLineType = "store_credit"
	PaymentLineTypeGiftCard    PaymentLineType = "gift_card"
	PaymentLineTypeSurcharge   PaymentLineType = "surcharge"
	PaymentLineTypeTip         PaymentLineType = "tip"
)

func (PaymentLineType) ToPointer 

func (e PaymentLineType) ToPointer() *PaymentLineType

func (*PaymentLineType) UnmarshalJSON 

func (e *PaymentLineType) UnmarshalJSON(data []byte) error

type PaymentLineTypeResponse 

type PaymentLineTypeResponse string

PaymentLineTypeResponse - The type of product purchased. For example, a physical or a digital product.

The `tip` payment line type is not available when creating a payment. 

const (
	PaymentLineTypeResponsePhysical    PaymentLineTypeResponse = "physical"
	PaymentLineTypeResponseDigital     PaymentLineTypeResponse = "digital"
	PaymentLineTypeResponseShippingFee PaymentLineTypeResponse = "shipping_fee"
	PaymentLineTypeResponseDiscount    PaymentLineTypeResponse = "discount"
	PaymentLineTypeResponseStoreCredit PaymentLineTypeResponse = "store_credit"
	PaymentLineTypeResponseGiftCard    PaymentLineTypeResponse = "gift_card"
	PaymentLineTypeResponseSurcharge   PaymentLineTypeResponse = "surcharge"
	PaymentLineTypeResponseTip         PaymentLineTypeResponse = "tip"
)

func (PaymentLineTypeResponse) ToPointer 

func (e PaymentLineTypeResponse) ToPointer() *PaymentLineTypeResponse

type PaymentLinkResponse 

type PaymentLinkResponse struct {
	// Indicates the response contains a payment link object. Will always contain the string `payment-link` for this
	// endpoint.
	Resource *string `json:"resource,omitempty"`
	ID       *string `json:"id,omitempty"`
	// Whether this entity was created in live mode or in test mode.
	Mode *Mode `json:"mode,omitempty"`
	// A short description of the payment link. The description is visible in the Dashboard and will be shown on the
	// customer's bank or card statement when possible.
	Description *string `json:"description,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount *AmountNullable `json:"amount,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	MinimumAmount *AmountNullable `json:"minimumAmount,omitempty"`
	// Whether the payment link is archived. Customers will not be able to complete payments on archived payment links.
	Archived *bool `json:"archived,omitempty"`
	// The URL your customer will be redirected to after completing the payment process. If no redirect URL is provided,
	// the customer will be shown a generic message after completing the payment.
	RedirectURL *string `json:"redirectUrl,omitempty"`
	// The webhook URL where we will send payment status updates to.
	//
	// The webhookUrl is optional, but without a webhook you will miss out on important status changes to any payments
	// resulting from the payment link.
	//
	// The webhookUrl must be reachable from Mollie's point of view, so you cannot use `localhost`. If you want to use
	// webhook during development on `localhost`, you must use a tool like ngrok to have the webhooks delivered to your
	// local machine.
	WebhookURL *string `json:"webhookUrl,omitempty"`
	// Optionally provide the order lines for the payment. Each line contains details such as a description of the item
	// ordered and its price.
	//
	// All lines must have the same currency as the payment.
	//
	// Required for payment methods `billie`, `in3`, `klarna`, `riverty` and `voucher`.
	Lines           []PaymentLineItemResponse `json:"lines,omitempty"`
	BillingAddress  *PaymentAddress           `json:"billingAddress,omitempty"`
	ShippingAddress *PaymentAddress           `json:"shippingAddress,omitempty"`
	// The identifier referring to the [profile](get-profile) this entity belongs to.
	//
	// Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted in the creation
	// request. For organization-level credentials such as OAuth access tokens however, the `profileId` parameter is
	// required.
	ProfileID *string `json:"profileId,omitempty"`
	// Indicates whether the payment link is reusable. If this field is set to `true`, customers can make multiple
	// payments using the same link.
	//
	// If no value is specified, the field defaults to `false`, allowing only a single payment per link.
	Reusable *bool `json:"reusable,omitempty"`
	// The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	CreatedAt *string `json:"createdAt,omitempty"`
	// The date and time the payment link became paid, in ISO 8601 format.
	PaidAt *string `json:"paidAt,omitempty"`
	// The date and time the payment link is set to expire, in ISO 8601 format. If no expiry date was provided up front,
	// the payment link will not expire automatically.
	ExpiresAt *string `json:"expiresAt,omitempty"`
	// An array of payment methods that are allowed to be used for this payment link. When this parameter is
	// not provided or is an empty array, all enabled payment methods will be available.
	//
	// Enum: 'applepay', 'bancomatpay', 'bancontact', 'banktransfer', 'belfius', 'blik', 'creditcard', 'eps', 'giftcard',
	// 'ideal', 'kbc', 'mybank', 'paybybank', 'paypal', 'paysafecard', 'pointofsale', 'przelewy24', 'satispay', 'trustly', 'twint',
	// 'in3', 'riverty', 'klarna', 'billie'.
	AllowedMethods []string `json:"allowedMethods,omitempty"`
	// With Mollie Connect you can charge fees on payment links that your app is processing on behalf of other Mollie
	// merchants.
	//
	// If you use OAuth to create payment links on a connected merchant's account, you can charge a fee using this
	// `applicationFee` parameter. If a payment on the payment link succeeds, the fee will be deducted from the merchant's balance and sent
	// to your own account balance.
	ApplicationFee *PaymentLinkResponseApplicationFee `json:"applicationFee,omitempty"`
	SequenceType   *PaymentLinkSequenceTypeResponse   `json:"sequenceType,omitempty"`
	// **Only relevant when `sequenceType` is set to `first`**
	//
	// The ID of the [customer](get-customer) the payment link is being created for. If a value is not provided,
	// the customer will be required to input relevant information which will be used to establish a mandate after
	// the payment is made.
	CustomerID *string `json:"customerId,omitempty"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links *PaymentLinkResponseLinks `json:"_links,omitempty"`
}

func (*PaymentLinkResponse) GetAllowedMethods 

func (p *PaymentLinkResponse) GetAllowedMethods() []string

func (*PaymentLinkResponse) GetAmount 

func (p *PaymentLinkResponse) GetAmount() *AmountNullable

func (*PaymentLinkResponse) GetApplicationFee 

func (p *PaymentLinkResponse) GetApplicationFee() *PaymentLinkResponseApplicationFee

func (*PaymentLinkResponse) GetArchived 

func (p *PaymentLinkResponse) GetArchived() *bool

func (*PaymentLinkResponse) GetBillingAddress 

func (p *PaymentLinkResponse) GetBillingAddress() *PaymentAddress

func (*PaymentLinkResponse) GetCreatedAt 

func (p *PaymentLinkResponse) GetCreatedAt() *string

func (*PaymentLinkResponse) GetCustomerID 

func (p *PaymentLinkResponse) GetCustomerID() *string

func (*PaymentLinkResponse) GetDescription 

func (p *PaymentLinkResponse) GetDescription() *string

func (*PaymentLinkResponse) GetExpiresAt 

func (p *PaymentLinkResponse) GetExpiresAt() *string

func (*PaymentLinkResponse) GetID 

func (p *PaymentLinkResponse) GetID() *string

func (*PaymentLinkResponse) GetLines 

func (p *PaymentLinkResponse) GetLines() []PaymentLineItemResponse
func (p *PaymentLinkResponse) GetLinks() *PaymentLinkResponseLinks

func (*PaymentLinkResponse) GetMinimumAmount 

func (p *PaymentLinkResponse) GetMinimumAmount() *AmountNullable

func (*PaymentLinkResponse) GetMode 

func (p *PaymentLinkResponse) GetMode() *Mode

func (*PaymentLinkResponse) GetPaidAt 

func (p *PaymentLinkResponse) GetPaidAt() *string

func (*PaymentLinkResponse) GetProfileID 

func (p *PaymentLinkResponse) GetProfileID() *string

func (*PaymentLinkResponse) GetRedirectURL 

func (p *PaymentLinkResponse) GetRedirectURL() *string

func (*PaymentLinkResponse) GetResource 

func (p *PaymentLinkResponse) GetResource() *string

func (*PaymentLinkResponse) GetReusable 

func (p *PaymentLinkResponse) GetReusable() *bool

func (*PaymentLinkResponse) GetSequenceType 

func (p *PaymentLinkResponse) GetSequenceType() *PaymentLinkSequenceTypeResponse

func (*PaymentLinkResponse) GetShippingAddress 

func (p *PaymentLinkResponse) GetShippingAddress() *PaymentAddress

func (*PaymentLinkResponse) GetWebhookURL 

func (p *PaymentLinkResponse) GetWebhookURL() *string

func (PaymentLinkResponse) MarshalJSON 

func (p PaymentLinkResponse) MarshalJSON() ([]byte, error)

func (*PaymentLinkResponse) UnmarshalJSON 

func (p *PaymentLinkResponse) UnmarshalJSON(data []byte) error

type PaymentLinkResponseApplicationFee 

type PaymentLinkResponseApplicationFee struct {
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount Amount `json:"amount"`
	// The description of the application fee. This will appear on settlement reports towards both you and the
	// connected merchant.
	Description string `json:"description"`
}

PaymentLinkResponseApplicationFee - With Mollie Connect you can charge fees on payment links that your app is processing on behalf of other Mollie merchants.

If you use OAuth to create payment links on a connected merchant's account, you can charge a fee using this `applicationFee` parameter. If a payment on the payment link succeeds, the fee will be deducted from the merchant's balance and sent to your own account balance.

func (*PaymentLinkResponseApplicationFee) GetAmount 

func (p *PaymentLinkResponseApplicationFee) GetAmount() Amount

func (*PaymentLinkResponseApplicationFee) GetDescription 

func (p *PaymentLinkResponseApplicationFee) GetDescription() string

func (PaymentLinkResponseApplicationFee) MarshalJSON 

func (p PaymentLinkResponseApplicationFee) MarshalJSON() ([]byte, error)

func (*PaymentLinkResponseApplicationFee) UnmarshalJSON 

func (p *PaymentLinkResponseApplicationFee) UnmarshalJSON(data []byte) error
type PaymentLinkResponseLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self URLObj `json:"self"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	PaymentLink URLObj `json:"paymentLink"`
}

PaymentLinkResponseLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field. 

func (p *PaymentLinkResponseLinks) GetPaymentLink() URLObj

func (*PaymentLinkResponseLinks) GetSelf 

func (p *PaymentLinkResponseLinks) GetSelf() URLObj

func (PaymentLinkResponseLinks) MarshalJSON 

func (p PaymentLinkResponseLinks) MarshalJSON() ([]byte, error)

func (*PaymentLinkResponseLinks) UnmarshalJSON 

func (p *PaymentLinkResponseLinks) UnmarshalJSON(data []byte) error

type PaymentLinkSequenceType 

type PaymentLinkSequenceType string
const (
	PaymentLinkSequenceTypeOneoff PaymentLinkSequenceType = "oneoff"
	PaymentLinkSequenceTypeFirst  PaymentLinkSequenceType = "first"
)

func (PaymentLinkSequenceType) ToPointer 

func (e PaymentLinkSequenceType) ToPointer() *PaymentLinkSequenceType

func (*PaymentLinkSequenceType) UnmarshalJSON 

func (e *PaymentLinkSequenceType) UnmarshalJSON(data []byte) error

type PaymentLinkSequenceTypeResponse 

type PaymentLinkSequenceTypeResponse string
const (
	PaymentLinkSequenceTypeResponseOneoff PaymentLinkSequenceTypeResponse = "oneoff"
	PaymentLinkSequenceTypeResponseFirst  PaymentLinkSequenceTypeResponse = "first"
)

func (PaymentLinkSequenceTypeResponse) ToPointer 

func (e PaymentLinkSequenceTypeResponse) ToPointer() *PaymentLinkSequenceTypeResponse

type PaymentMethod 

type PaymentMethod string

PaymentMethod - The payment method, if applicable 

const (
	PaymentMethodAlma              PaymentMethod = "alma"
	PaymentMethodBacs              PaymentMethod = "bacs"
	PaymentMethodApplepay          PaymentMethod = "applepay"
	PaymentMethodBancomatpay       PaymentMethod = "bancomatpay"
	PaymentMethodBancontact        PaymentMethod = "bancontact"
	PaymentMethodBanktransfer      PaymentMethod = "banktransfer"
	PaymentMethodBelfius           PaymentMethod = "belfius"
	PaymentMethodBillie            PaymentMethod = "billie"
	PaymentMethodBizum             PaymentMethod = "bizum"
	PaymentMethodBitcoin           PaymentMethod = "bitcoin"
	PaymentMethodBlik              PaymentMethod = "blik"
	PaymentMethodCreditcard        PaymentMethod = "creditcard"
	PaymentMethodDirectdebit       PaymentMethod = "directdebit"
	PaymentMethodEps               PaymentMethod = "eps"
	PaymentMethodGiftcard          PaymentMethod = "giftcard"
	PaymentMethodGiropay           PaymentMethod = "giropay"
	PaymentMethodGooglepay         PaymentMethod = "googlepay"
	PaymentMethodIdeal             PaymentMethod = "ideal"
	PaymentMethodIn3               PaymentMethod = "in3"
	PaymentMethodInghomepay        PaymentMethod = "inghomepay"
	PaymentMethodKbc               PaymentMethod = "kbc"
	PaymentMethodKlarnapaylater    PaymentMethod = "klarnapaylater"
	PaymentMethodKlarnapaynow      PaymentMethod = "klarnapaynow"
	PaymentMethodKlarnasliceit     PaymentMethod = "klarnasliceit"
	PaymentMethodKlarna            PaymentMethod = "klarna"
	PaymentMethodMbway             PaymentMethod = "mbway"
	PaymentMethodMultibanco        PaymentMethod = "multibanco"
	PaymentMethodMybank            PaymentMethod = "mybank"
	PaymentMethodPaybybank         PaymentMethod = "paybybank"
	PaymentMethodPayconiq          PaymentMethod = "payconiq"
	PaymentMethodPaypal            PaymentMethod = "paypal"
	PaymentMethodPaysafecard       PaymentMethod = "paysafecard"
	PaymentMethodPrzelewy24        PaymentMethod = "przelewy24"
	PaymentMethodRiverty           PaymentMethod = "riverty"
	PaymentMethodSatispay          PaymentMethod = "satispay"
	PaymentMethodPodiumcadeaukaart PaymentMethod = "podiumcadeaukaart"
	PaymentMethodPointofsale       PaymentMethod = "pointofsale"
	PaymentMethodSofort            PaymentMethod = "sofort"
	PaymentMethodSwish             PaymentMethod = "swish"
	PaymentMethodTrustly           PaymentMethod = "trustly"
	PaymentMethodTwint             PaymentMethod = "twint"
	PaymentMethodVoucher           PaymentMethod = "voucher"
)

func (PaymentMethod) ToPointer 

func (e PaymentMethod) ToPointer() *PaymentMethod

type PaymentRequest 

type PaymentRequest struct {
	ID *string `json:"id,omitempty"`
	// The description of the payment. This will be shown to your customer on their card or bank statement when possible.
	// We truncate the description automatically according to the limits of the used payment method. The description is
	// also visible in any exports you generate.
	//
	// We recommend you use a unique identifier so that you can always link the payment to the order in your back office.
	// This is particularly useful for bookkeeping.
	//
	// The maximum length of the description field differs per payment method, with the absolute maximum being 255
	// characters. The API will not reject strings longer than the maximum length but it will truncate them to fit.
	Description *string `json:"description,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount *Amount `json:"amount,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	AmountRefunded *Amount `json:"amountRefunded,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	AmountRemaining *Amount `json:"amountRemaining,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	AmountCaptured *Amount `json:"amountCaptured,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	AmountChargedBack *Amount `json:"amountChargedBack,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	SettlementAmount *Amount `json:"settlementAmount,omitempty"`
	// The URL your customer will be redirected to after the payment process.
	//
	// It could make sense for the redirectUrl to contain a unique identifier – like your order ID – so you can show the
	// right page referencing the order when your customer returns.
	//
	// The parameter is normally required, but can be omitted for recurring payments (`sequenceType: recurring`) and for
	// Apple Pay payments with an `applePayPaymentToken`.
	RedirectURL *string `json:"redirectUrl,omitempty"`
	// The URL your customer will be redirected to when the customer explicitly cancels the payment. If this URL is not
	// provided, the customer will be redirected to the `redirectUrl` instead — see above.
	//
	// Mollie will always give you status updates via webhooks, including for the canceled status. This parameter is
	// therefore entirely optional, but can be useful when implementing a dedicated customer-facing flow to handle
	// payment cancellations.
	CancelURL *string `json:"cancelUrl,omitempty"`
	// The webhook URL where we will send payment status updates to.
	//
	// The webhookUrl is optional, but without a webhook you will miss out on important status changes to your payment.
	//
	// The webhookUrl must be reachable from Mollie's point of view, so you cannot use `localhost`. If you want to use
	// webhook during development on `localhost`, you must use a tool like ngrok to have the webhooks delivered to your
	// local machine.
	WebhookURL *string `json:"webhookUrl,omitempty"`
	// Optionally provide the order lines for the payment. Each line contains details such as a description of the item
	// ordered and its price.
	//
	// All lines must have the same currency as the payment.
	//
	// Required for payment methods `billie`, `in3`, `klarna`, `riverty` and `voucher`.
	Lines           []PaymentRequestLine `json:"lines,omitempty"`
	BillingAddress  *PaymentAddress      `json:"billingAddress,omitempty"`
	ShippingAddress *PaymentAddress      `json:"shippingAddress,omitempty"`
	// Allows you to preset the language to be used.
	Locale *Locale `json:"locale,omitempty"`
	// Normally, a payment method screen is shown. However, when using this parameter, you can choose a specific payment
	// method and your customer will skip the selection screen and is sent directly to the chosen payment method. The
	// parameter enables you to fully integrate the payment method selection into your website.
	//
	// You can also specify the methods in an array. By doing so we will still show the payment method selection screen
	// but will only show the methods specified in the array. For example, you can use this functionality to only show
	// payment methods from a specific country to your customer `['bancontact', 'belfius']`.
	Method *Method `json:"method,omitempty"`
	// **Only relevant for iDEAL, KBC/CBC, gift card, and voucher payments.**
	//
	// **⚠️ With the introduction of iDEAL 2 in 2025, this field will be ignored for iDEAL payments. For more information
	// on the migration, refer to our [help center](https://help.mollie.com/hc/articles/19100313768338-iDEAL-2-0).**
	//
	// Some payment methods are a network of connected banks or card issuers. In these cases, after selecting the payment
	// method, the customer may still need to select the appropriate issuer before the payment can proceed.
	//
	// We provide hosted issuer selection screens, but these screens can be skipped by providing the `issuer` via the API
	// up front.
	//
	// The full list of issuers for a specific method can be retrieved via the Methods API by using the optional
	// `issuers` include.
	//
	// A valid issuer for iDEAL is for example `ideal_INGBNL2A` (for ING Bank).
	Issuer *string `json:"issuer,omitempty"`
	// For digital goods in most jurisdictions, you must apply the VAT rate from your customer's country. Choose the VAT
	// rates you have used for the order to ensure your customer's country matches the VAT country.
	//
	// Use this parameter to restrict the payment methods available to your customer to those from a single country.
	//
	// If available, the credit card method will still be offered, but only cards from the allowed country are accepted.
	//
	// The field expects a country code in ISO 3166-1 alpha-2 format, for example `NL`.
	RestrictPaymentMethodsToCountry *string `json:"restrictPaymentMethodsToCountry,omitempty"`
	// Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever
	// you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
	Metadata *Metadata `json:"metadata,omitempty"`
	// Indicate if the funds should be captured immediately or if you want to [place a hold](https://docs.mollie.com/docs/place-a-hold-for-a-payment#/)
	// and capture at a later time.
	//
	// This field needs to be set to `manual` for method `riverty`.
	CaptureMode *CaptureMode `json:"captureMode,omitempty"`
	// **Only relevant if you wish to manage authorization and capturing separately.**
	//
	// Some payment methods allow placing a hold on the card or bank account. This hold or 'authorization' can then at a
	// later point either be 'captured' or canceled.
	//
	// By default, we charge the customer's card or bank account immediately when they complete the payment. If you set a
	// capture delay however, we will delay the automatic capturing of the payment for the specified amount of time. For
	// example `8 hours` or `2 days`.
	//
	// To schedule an automatic capture, the `captureMode` must be set to `automatic`.
	//
	// The maximum delay is 7 days (168 hours).
	//
	// Possible values: `... hours` `... days`
	CaptureDelay *string `json:"captureDelay,omitempty"`
	// With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie
	// merchants.
	//
	// If you use OAuth to create payments on a connected merchant's account, you can charge a fee using this
	// `applicationFee` parameter. If the payment succeeds, the fee will be deducted from the merchant's balance and sent
	// to your own account balance.
	//
	// If instead you want to split a payment on your own account between yourself and a connected merchant, refer to the
	// `routing` parameter.
	ApplicationFee *PaymentRequestApplicationFee `json:"applicationFee,omitempty"`
	// *This functionality is not enabled by default. Reach out to our partner management team if you wish to use it.*
	//
	// With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie
	// merchants.
	//
	// If you create payments on your own account that you want to split between yourself and one or more connected
	// merchants, you can use this `routing` parameter to route the payment accordingly.
	//
	// The `routing` parameter should contain an array of objects, with each object describing the destination for a
	// specific portion of the payment.
	//
	// It is not necessary to indicate in the array which portion goes to yourself. After all portions of the total
	// payment amount have been routed, the amount left will be routed to the current organization automatically.
	//
	// If instead you use OAuth to create payments on a connected merchant's account, refer to the `applicationFee`
	// parameter.
	Routing        []EntityPaymentRoute `json:"routing,omitempty"`
	SequenceType   *SequenceType        `json:"sequenceType,omitempty"`
	SubscriptionID *string              `json:"subscriptionId,omitempty"`
	MandateID      *string              `json:"mandateId,omitempty"`
	CustomerID     *string              `json:"customerId,omitempty"`
	// The identifier referring to the [profile](get-profile) this entity belongs to.
	//
	// Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted in the creation
	// request. For organization-level credentials such as OAuth access tokens however, the `profileId` parameter is
	// required.
	ProfileID    *string `json:"profileId,omitempty"`
	SettlementID *string `json:"settlementId,omitempty"`
	OrderID      *string `json:"orderId,omitempty"`
	// The date by which the payment should be completed in `YYYY-MM-DD` format
	DueDate *string `json:"dueDate,omitempty"`
	// Whether to create the entity in test mode or live mode.
	//
	// Most API credentials are specifically created for either live mode or test mode, in which case this parameter can be
	// omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting
	// `testmode` to `true`.
	Testmode *bool `json:"testmode,omitempty"`
	// The Apple Pay Payment token object (encoded as JSON) that is part of the result of authorizing a payment request.
	// The token contains the payment information needed to authorize the payment.
	//
	// The object should be passed encoded in a JSON string.
	ApplePayPaymentToken *string `json:"applePayPaymentToken,omitempty"`
	// Billie is a business-to-business (B2B) payment method. It requires extra information to identify the organization
	// that is completing the payment. It is recommended to include these parameters up front for a seamless flow.
	// Otherwise, Billie will ask the customer to complete the missing fields during checkout.
	Company *Company `json:"company,omitempty"`
	// When creating credit card payments using Mollie Components, you need to provide the card token you received from
	// the card component in this field. The token represents the customer's card information needed to complete the
	// payment. Note: field only valid for oneoff and first payments. For recurring payments, the customerId alone is
	// enough.
	CardToken *string `json:"cardToken,omitempty"`
	// The card token you received from the card component of Mollie Components. The token represents the customer's card
	// information needed to complete the payment.
	VoucherNumber *string `json:"voucherNumber,omitempty"`
	// The PIN on the gift card. You can supply this to prefill the PIN, if the card has any.
	VoucherPin *string `json:"voucherPin,omitempty"`
	// The customer's date of birth. If not provided via the API, iDeal in3 will ask the customer to provide it during
	// the payment process.
	ConsumerDateOfBirth *types.Date `json:"consumerDateOfBirth,omitempty"`
	// For some industries, additional purchase information can be sent to Klarna to increase the authorization rate.
	// You can submit your extra data in this field if you have agreed upon this with Klarna. This field should be an
	// object containing any of the allowed keys and sub-objects described at the Klarna Developer Documentation.
	ExtraMerchantData map[string]any `json:"extraMerchantData,omitempty"`
	// The unique ID you have used for the PayPal fraud library. You should include this if you use PayPal for an
	// on-demand payment.
	SessionID *string `json:"sessionId,omitempty"`
	// Indicate if you are about to deliver digital goods, such as for example a software license. Setting this parameter
	// can have consequences for your PayPal Seller Protection. Refer to PayPal's documentation for more information.
	DigitalGoods *bool `json:"digitalGoods,omitempty"`
	// Used by paysafecard for customer identification across payments. When you generate a customer reference yourself,
	// make sure not to put personal identifiable information or IP addresses in the customer reference directly.
	CustomerReference *string `json:"customerReference,omitempty"`
	// The ID of the terminal device where you want to initiate the payment on.
	TerminalID *string `json:"terminalId,omitempty"`
}

func (*PaymentRequest) GetAmount 

func (p *PaymentRequest) GetAmount() *Amount

func (*PaymentRequest) GetAmountCaptured 

func (p *PaymentRequest) GetAmountCaptured() *Amount

func (*PaymentRequest) GetAmountChargedBack 

func (p *PaymentRequest) GetAmountChargedBack() *Amount

func (*PaymentRequest) GetAmountRefunded 

func (p *PaymentRequest) GetAmountRefunded() *Amount

func (*PaymentRequest) GetAmountRemaining 

func (p *PaymentRequest) GetAmountRemaining() *Amount

func (*PaymentRequest) GetApplePayPaymentToken 

func (p *PaymentRequest) GetApplePayPaymentToken() *string

func (*PaymentRequest) GetApplicationFee 

func (p *PaymentRequest) GetApplicationFee() *PaymentRequestApplicationFee

func (*PaymentRequest) GetBillingAddress 

func (p *PaymentRequest) GetBillingAddress() *PaymentAddress

func (*PaymentRequest) GetCancelURL 

func (p *PaymentRequest) GetCancelURL() *string

func (*PaymentRequest) GetCaptureDelay 

func (p *PaymentRequest) GetCaptureDelay() *string

func (*PaymentRequest) GetCaptureMode 

func (p *PaymentRequest) GetCaptureMode() *CaptureMode

func (*PaymentRequest) GetCardToken 

func (p *PaymentRequest) GetCardToken() *string

func (*PaymentRequest) GetCompany 

func (p *PaymentRequest) GetCompany() *Company

func (*PaymentRequest) GetConsumerDateOfBirth 

func (p *PaymentRequest) GetConsumerDateOfBirth() *types.Date

func (*PaymentRequest) GetCustomerID 

func (p *PaymentRequest) GetCustomerID() *string

func (*PaymentRequest) GetCustomerReference 

func (p *PaymentRequest) GetCustomerReference() *string

func (*PaymentRequest) GetDescription 

func (p *PaymentRequest) GetDescription() *string

func (*PaymentRequest) GetDigitalGoods 

func (p *PaymentRequest) GetDigitalGoods() *bool

func (*PaymentRequest) GetDueDate 

func (p *PaymentRequest) GetDueDate() *string

func (*PaymentRequest) GetExtraMerchantData 

func (p *PaymentRequest) GetExtraMerchantData() map[string]any

func (*PaymentRequest) GetID 

func (p *PaymentRequest) GetID() *string

func (*PaymentRequest) GetIssuer 

func (p *PaymentRequest) GetIssuer() *string

func (*PaymentRequest) GetLines 

func (p *PaymentRequest) GetLines() []PaymentRequestLine

func (*PaymentRequest) GetLocale 

func (p *PaymentRequest) GetLocale() *Locale

func (*PaymentRequest) GetMandateID 

func (p *PaymentRequest) GetMandateID() *string

func (*PaymentRequest) GetMetadata 

func (p *PaymentRequest) GetMetadata() *Metadata

func (*PaymentRequest) GetMethod 

func (p *PaymentRequest) GetMethod() *Method

func (*PaymentRequest) GetOrderID 

func (p *PaymentRequest) GetOrderID() *string

func (*PaymentRequest) GetProfileID 

func (p *PaymentRequest) GetProfileID() *string

func (*PaymentRequest) GetRedirectURL 

func (p *PaymentRequest) GetRedirectURL() *string

func (*PaymentRequest) GetRestrictPaymentMethodsToCountry 

func (p *PaymentRequest) GetRestrictPaymentMethodsToCountry() *string

func (*PaymentRequest) GetRouting 

func (p *PaymentRequest) GetRouting() []EntityPaymentRoute

func (*PaymentRequest) GetSequenceType 

func (p *PaymentRequest) GetSequenceType() *SequenceType

func (*PaymentRequest) GetSessionID 

func (p *PaymentRequest) GetSessionID() *string

func (*PaymentRequest) GetSettlementAmount 

func (p *PaymentRequest) GetSettlementAmount() *Amount

func (*PaymentRequest) GetSettlementID 

func (p *PaymentRequest) GetSettlementID() *string

func (*PaymentRequest) GetShippingAddress 

func (p *PaymentRequest) GetShippingAddress() *PaymentAddress

func (*PaymentRequest) GetSubscriptionID 

func (p *PaymentRequest) GetSubscriptionID() *string

func (*PaymentRequest) GetTerminalID 

func (p *PaymentRequest) GetTerminalID() *string

func (*PaymentRequest) GetTestmode 

func (p *PaymentRequest) GetTestmode() *bool

func (*PaymentRequest) GetVoucherNumber 

func (p *PaymentRequest) GetVoucherNumber() *string

func (*PaymentRequest) GetVoucherPin 

func (p *PaymentRequest) GetVoucherPin() *string

func (*PaymentRequest) GetWebhookURL 

func (p *PaymentRequest) GetWebhookURL() *string

func (PaymentRequest) MarshalJSON 

func (p PaymentRequest) MarshalJSON() ([]byte, error)

func (*PaymentRequest) UnmarshalJSON 

func (p *PaymentRequest) UnmarshalJSON(data []byte) error

type PaymentRequestApplicationFee 

type PaymentRequestApplicationFee struct {
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount *Amount `json:"amount,omitempty"`
	// The description of the application fee. This will appear on settlement reports towards both you and the
	// connected merchant.
	Description *string `json:"description,omitempty"`
}

PaymentRequestApplicationFee - With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie merchants.

If you use OAuth to create payments on a connected merchant's account, you can charge a fee using this `applicationFee` parameter. If the payment succeeds, the fee will be deducted from the merchant's balance and sent to your own account balance.

If instead you want to split a payment on your own account between yourself and a connected merchant, refer to the `routing` parameter.

func (*PaymentRequestApplicationFee) GetAmount 

func (p *PaymentRequestApplicationFee) GetAmount() *Amount

func (*PaymentRequestApplicationFee) GetDescription 

func (p *PaymentRequestApplicationFee) GetDescription() *string

type PaymentRequestLine 

type PaymentRequestLine struct {
	// The type of product purchased. For example, a physical or a digital product.
	//
	// The `tip` payment line type is not available when creating a payment.
	Type *PaymentLineType `json:"type,omitempty"`
	// A description of the line item. For example *LEGO 4440 Forest Police Station*.
	Description string `json:"description"`
	// The number of items.
	Quantity int64 `json:"quantity"`
	// The unit for the quantity. For example *pcs*, *kg*, or *cm*.
	QuantityUnit *string `json:"quantityUnit,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	UnitPrice Amount `json:"unitPrice"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	DiscountAmount *Amount `json:"discountAmount,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	TotalAmount Amount `json:"totalAmount"`
	// The VAT rate applied to the line, for example `21.00` for 21%. The vatRate should be passed as a string and
	// not as a float, to ensure the correct number of decimals are passed.
	VatRate *string `json:"vatRate,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	VatAmount *Amount `json:"vatAmount,omitempty"`
	// The SKU, EAN, ISBN or UPC of the product sold.
	Sku *string `json:"sku,omitempty"`
	// An array with the voucher categories, in case of a line eligible for a voucher. See the
	// [Integrating Vouchers](https://docs.mollie.com/docs/integrating-vouchers/) guide for more information.
	Categories []LineCategories `json:"categories,omitempty"`
	// A link pointing to an image of the product sold.
	ImageURL *string `json:"imageUrl,omitempty"`
	// A link pointing to the product page in your web shop of the product sold.
	ProductURL *string            `json:"productUrl,omitempty"`
	Recurring  *RecurringLineItem `json:"recurring,omitempty"`
}

func (*PaymentRequestLine) GetCategories 

func (p *PaymentRequestLine) GetCategories() []LineCategories

func (*PaymentRequestLine) GetDescription 

func (p *PaymentRequestLine) GetDescription() string

func (*PaymentRequestLine) GetDiscountAmount 

func (p *PaymentRequestLine) GetDiscountAmount() *Amount

func (*PaymentRequestLine) GetImageURL 

func (p *PaymentRequestLine) GetImageURL() *string

func (*PaymentRequestLine) GetProductURL 

func (p *PaymentRequestLine) GetProductURL() *string

func (*PaymentRequestLine) GetQuantity 

func (p *PaymentRequestLine) GetQuantity() int64

func (*PaymentRequestLine) GetQuantityUnit 

func (p *PaymentRequestLine) GetQuantityUnit() *string

func (*PaymentRequestLine) GetRecurring 

func (p *PaymentRequestLine) GetRecurring() *RecurringLineItem

func (*PaymentRequestLine) GetSku 

func (p *PaymentRequestLine) GetSku() *string

func (*PaymentRequestLine) GetTotalAmount 

func (p *PaymentRequestLine) GetTotalAmount() Amount

func (*PaymentRequestLine) GetType 

func (p *PaymentRequestLine) GetType() *PaymentLineType

func (*PaymentRequestLine) GetUnitPrice 

func (p *PaymentRequestLine) GetUnitPrice() Amount

func (*PaymentRequestLine) GetVatAmount 

func (p *PaymentRequestLine) GetVatAmount() *Amount

func (*PaymentRequestLine) GetVatRate 

func (p *PaymentRequestLine) GetVatRate() *string

type PaymentResponse 

type PaymentResponse struct {
	// Indicates the response contains a payment object. Will always contain the string `payment` for this endpoint.
	Resource *string `json:"resource,omitempty"`
	ID       *string `json:"id,omitempty"`
	// Whether this entity was created in live mode or in test mode.
	Mode *Mode `json:"mode,omitempty"`
	// The description of the payment. This will be shown to your customer on their card or bank statement when possible.
	// We truncate the description automatically according to the limits of the used payment method. The description is
	// also visible in any exports you generate.
	//
	// We recommend you use a unique identifier so that you can always link the payment to the order in your back office.
	// This is particularly useful for bookkeeping.
	//
	// The maximum length of the description field differs per payment method, with the absolute maximum being 255
	// characters. The API will not reject strings longer than the maximum length but it will truncate them to fit.
	Description *string `json:"description,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount *Amount `json:"amount,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	AmountRefunded *Amount `json:"amountRefunded,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	AmountRemaining *Amount `json:"amountRemaining,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	AmountCaptured *Amount `json:"amountCaptured,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	AmountChargedBack *Amount `json:"amountChargedBack,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	SettlementAmount *Amount `json:"settlementAmount,omitempty"`
	// The URL your customer will be redirected to after the payment process.
	//
	// It could make sense for the redirectUrl to contain a unique identifier – like your order ID – so you can show the
	// right page referencing the order when your customer returns.
	//
	// The parameter is normally required, but can be omitted for recurring payments (`sequenceType: recurring`) and for
	// Apple Pay payments with an `applePayPaymentToken`.
	RedirectURL *string `json:"redirectUrl,omitempty"`
	// The URL your customer will be redirected to when the customer explicitly cancels the payment. If this URL is not
	// provided, the customer will be redirected to the `redirectUrl` instead — see above.
	//
	// Mollie will always give you status updates via webhooks, including for the canceled status. This parameter is
	// therefore entirely optional, but can be useful when implementing a dedicated customer-facing flow to handle
	// payment cancellations.
	CancelURL *string `json:"cancelUrl,omitempty"`
	// The webhook URL where we will send payment status updates to.
	//
	// The webhookUrl is optional, but without a webhook you will miss out on important status changes to your payment.
	//
	// The webhookUrl must be reachable from Mollie's point of view, so you cannot use `localhost`. If you want to use
	// webhook during development on `localhost`, you must use a tool like ngrok to have the webhooks delivered to your
	// local machine.
	WebhookURL *string `json:"webhookUrl,omitempty"`
	// Optionally provide the order lines for the payment. Each line contains details such as a description of the item
	// ordered and its price.
	//
	// All lines must have the same currency as the payment.
	//
	// Required for payment methods `billie`, `in3`, `klarna`, `riverty` and `voucher`.
	Lines           []PaymentResponseLine `json:"lines,omitempty"`
	BillingAddress  *PaymentAddress       `json:"billingAddress,omitempty"`
	ShippingAddress *PaymentAddress       `json:"shippingAddress,omitempty"`
	// Allows you to preset the language to be used.
	Locale *LocaleResponse `json:"locale,omitempty"`
	// This optional field contains your customer's ISO 3166-1 alpha-2 country code, detected by us during checkout. This
	// field is omitted if the country code was not detected.
	CountryCode *string `json:"countryCode,omitempty"`
	// Normally, a payment method screen is shown. However, when using this parameter, you can choose a specific payment
	// method and your customer will skip the selection screen and is sent directly to the chosen payment method. The
	// parameter enables you to fully integrate the payment method selection into your website.
	//
	// You can also specify the methods in an array. By doing so we will still show the payment method selection screen
	// but will only show the methods specified in the array. For example, you can use this functionality to only show
	// payment methods from a specific country to your customer `['bancontact', 'belfius']`.
	Method *MethodResponse `json:"method,omitempty"`
	// For digital goods in most jurisdictions, you must apply the VAT rate from your customer's country. Choose the VAT
	// rates you have used for the order to ensure your customer's country matches the VAT country.
	//
	// Use this parameter to restrict the payment methods available to your customer to those from a single country.
	//
	// If available, the credit card method will still be offered, but only cards from the allowed country are accepted.
	//
	// The field expects a country code in ISO 3166-1 alpha-2 format, for example `NL`.
	RestrictPaymentMethodsToCountry *string `json:"restrictPaymentMethodsToCountry,omitempty"`
	// Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever
	// you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
	Metadata *Metadata `json:"metadata,omitempty"`
	// Indicate if the funds should be captured immediately or if you want to [place a hold](https://docs.mollie.com/docs/place-a-hold-for-a-payment#/)
	// and capture at a later time.
	//
	// This field needs to be set to `manual` for method `riverty`.
	CaptureMode *CaptureModeResponse `json:"captureMode,omitempty"`
	// **Only relevant if you wish to manage authorization and capturing separately.**
	//
	// Some payment methods allow placing a hold on the card or bank account. This hold or 'authorization' can then at a
	// later point either be 'captured' or canceled.
	//
	// By default, we charge the customer's card or bank account immediately when they complete the payment. If you set a
	// capture delay however, we will delay the automatic capturing of the payment for the specified amount of time. For
	// example `8 hours` or `2 days`.
	//
	// To schedule an automatic capture, the `captureMode` must be set to `automatic`.
	//
	// The maximum delay is 7 days (168 hours).
	//
	// Possible values: `... hours` `... days`
	CaptureDelay *string `json:"captureDelay,omitempty"`
	// Indicates the date before which the payment needs to be captured, in ISO 8601 format. From this date onwards we
	// can no longer guarantee a successful capture. The parameter is omitted if the payment is not authorized (yet).
	CaptureBefore *string `json:"captureBefore,omitempty"`
	// With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie
	// merchants.
	//
	// If you use OAuth to create payments on a connected merchant's account, you can charge a fee using this
	// `applicationFee` parameter. If the payment succeeds, the fee will be deducted from the merchant's balance and sent
	// to your own account balance.
	//
	// If instead you want to split a payment on your own account between yourself and a connected merchant, refer to the
	// `routing` parameter.
	ApplicationFee *PaymentResponseApplicationFee `json:"applicationFee,omitempty"`
	// *This functionality is not enabled by default. Reach out to our partner management team if you wish to use it.*
	//
	// With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie
	// merchants.
	//
	// If you create payments on your own account that you want to split between yourself and one or more connected
	// merchants, you can use this `routing` parameter to route the payment accordingly.
	//
	// The `routing` parameter should contain an array of objects, with each object describing the destination for a
	// specific portion of the payment.
	//
	// It is not necessary to indicate in the array which portion goes to yourself. After all portions of the total
	// payment amount have been routed, the amount left will be routed to the current organization automatically.
	//
	// If instead you use OAuth to create payments on a connected merchant's account, refer to the `applicationFee`
	// parameter.
	Routing        []EntityPaymentRouteResponse `json:"routing,omitempty"`
	SequenceType   *SequenceTypeResponse        `json:"sequenceType,omitempty"`
	SubscriptionID *string                      `json:"subscriptionId,omitempty"`
	MandateID      *string                      `json:"mandateId,omitempty"`
	CustomerID     *string                      `json:"customerId,omitempty"`
	// The identifier referring to the [profile](get-profile) this entity belongs to.
	//
	// Most API credentials are linked to a single profile. In these cases the `profileId` can be omitted in the creation
	// request. For organization-level credentials such as OAuth access tokens however, the `profileId` parameter is
	// required.
	ProfileID    *string `json:"profileId,omitempty"`
	SettlementID *string `json:"settlementId,omitempty"`
	OrderID      *string `json:"orderId,omitempty"`
	// The payment's status. Refer to the [documentation regarding statuses](https://docs.mollie.com/docs/status-change#/) for more info about which
	// statuses occur at what point.
	Status *PaymentStatus `json:"status,omitempty"`
	// This object offers details about the status of a payment. Currently it is only available for point-of-sale
	// payments.
	//
	// You can find more information about the possible values of this object on
	// [this page](status-reasons).**
	StatusReason *StatusReason `json:"statusReason,omitempty"`
	// Whether the payment can be canceled. This parameter is omitted if the payment reaches a final state.
	IsCancelable *bool `json:"isCancelable,omitempty"`
	// An object containing payment details collected during the payment process. For example, details may include the
	// customer's card or bank details and a payment reference. For the full list of details, please refer to the
	// [method-specific parameters](extra-payment-parameters) guide.
	Details *PaymentResponseDetails `json:"details,omitempty"`
	// The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	CreatedAt *string `json:"createdAt,omitempty"`
	// The date and time the payment became authorized, in ISO 8601 format. This parameter is omitted if the payment is
	// not authorized (yet).
	AuthorizedAt *string `json:"authorizedAt,omitempty"`
	// The date and time the payment became paid, in ISO 8601 format. This parameter is omitted if the payment is not
	// completed (yet).
	PaidAt *string `json:"paidAt,omitempty"`
	// The date and time the payment was canceled, in ISO 8601 format. This parameter is omitted if the payment is not
	// canceled (yet).
	CanceledAt *string `json:"canceledAt,omitempty"`
	// The date and time the payment will expire, in ISO 8601 format. This parameter is omitted if the payment can no
	// longer expire.
	ExpiresAt *string `json:"expiresAt,omitempty"`
	// The date and time the payment was expired, in ISO 8601 format. This parameter is omitted if the payment did not
	// expire (yet).
	ExpiredAt *string `json:"expiredAt,omitempty"`
	// The date and time the payment failed, in ISO 8601 format. This parameter is omitted if the payment did not fail
	// (yet).
	FailedAt *string `json:"failedAt,omitempty"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links *PaymentResponseLinks `json:"_links,omitempty"`
}

func (*PaymentResponse) GetAmount 

func (p *PaymentResponse) GetAmount() *Amount

func (*PaymentResponse) GetAmountCaptured 

func (p *PaymentResponse) GetAmountCaptured() *Amount

func (*PaymentResponse) GetAmountChargedBack 

func (p *PaymentResponse) GetAmountChargedBack() *Amount

func (*PaymentResponse) GetAmountRefunded 

func (p *PaymentResponse) GetAmountRefunded() *Amount

func (*PaymentResponse) GetAmountRemaining 

func (p *PaymentResponse) GetAmountRemaining() *Amount

func (*PaymentResponse) GetApplicationFee 

func (p *PaymentResponse) GetApplicationFee() *PaymentResponseApplicationFee

func (*PaymentResponse) GetAuthorizedAt 

func (p *PaymentResponse) GetAuthorizedAt() *string

func (*PaymentResponse) GetBillingAddress 

func (p *PaymentResponse) GetBillingAddress() *PaymentAddress

func (*PaymentResponse) GetCancelURL 

func (p *PaymentResponse) GetCancelURL() *string

func (*PaymentResponse) GetCanceledAt 

func (p *PaymentResponse) GetCanceledAt() *string

func (*PaymentResponse) GetCaptureBefore 

func (p *PaymentResponse) GetCaptureBefore() *string

func (*PaymentResponse) GetCaptureDelay 

func (p *PaymentResponse) GetCaptureDelay() *string

func (*PaymentResponse) GetCaptureMode 

func (p *PaymentResponse) GetCaptureMode() *CaptureModeResponse

func (*PaymentResponse) GetCountryCode 

func (p *PaymentResponse) GetCountryCode() *string

func (*PaymentResponse) GetCreatedAt 

func (p *PaymentResponse) GetCreatedAt() *string

func (*PaymentResponse) GetCustomerID 

func (p *PaymentResponse) GetCustomerID() *string

func (*PaymentResponse) GetDescription 

func (p *PaymentResponse) GetDescription() *string

func (*PaymentResponse) GetDetails 

func (p *PaymentResponse) GetDetails() *PaymentResponseDetails

func (*PaymentResponse) GetExpiredAt 

func (p *PaymentResponse) GetExpiredAt() *string

func (*PaymentResponse) GetExpiresAt 

func (p *PaymentResponse) GetExpiresAt() *string

func (*PaymentResponse) GetFailedAt 

func (p *PaymentResponse) GetFailedAt() *string

func (*PaymentResponse) GetID 

func (p *PaymentResponse) GetID() *string

func (*PaymentResponse) GetIsCancelable 

func (p *PaymentResponse) GetIsCancelable() *bool

func (*PaymentResponse) GetLines 

func (p *PaymentResponse) GetLines() []PaymentResponseLine
func (p *PaymentResponse) GetLinks() *PaymentResponseLinks

func (*PaymentResponse) GetLocale 

func (p *PaymentResponse) GetLocale() *LocaleResponse

func (*PaymentResponse) GetMandateID 

func (p *PaymentResponse) GetMandateID() *string

func (*PaymentResponse) GetMetadata 

func (p *PaymentResponse) GetMetadata() *Metadata

func (*PaymentResponse) GetMethod 

func (p *PaymentResponse) GetMethod() *MethodResponse

func (*PaymentResponse) GetMode 

func (p *PaymentResponse) GetMode() *Mode

func (*PaymentResponse) GetOrderID 

func (p *PaymentResponse) GetOrderID() *string

func (*PaymentResponse) GetPaidAt 

func (p *PaymentResponse) GetPaidAt() *string

func (*PaymentResponse) GetProfileID 

func (p *PaymentResponse) GetProfileID() *string

func (*PaymentResponse) GetRedirectURL 

func (p *PaymentResponse) GetRedirectURL() *string

func (*PaymentResponse) GetResource 

func (p *PaymentResponse) GetResource() *string

func (*PaymentResponse) GetRestrictPaymentMethodsToCountry 

func (p *PaymentResponse) GetRestrictPaymentMethodsToCountry() *string

func (*PaymentResponse) GetRouting 

func (p *PaymentResponse) GetRouting() []EntityPaymentRouteResponse

func (*PaymentResponse) GetSequenceType 

func (p *PaymentResponse) GetSequenceType() *SequenceTypeResponse

func (*PaymentResponse) GetSettlementAmount 

func (p *PaymentResponse) GetSettlementAmount() *Amount

func (*PaymentResponse) GetSettlementID 

func (p *PaymentResponse) GetSettlementID() *string

func (*PaymentResponse) GetShippingAddress 

func (p *PaymentResponse) GetShippingAddress() *PaymentAddress

func (*PaymentResponse) GetStatus 

func (p *PaymentResponse) GetStatus() *PaymentStatus

func (*PaymentResponse) GetStatusReason 

func (p *PaymentResponse) GetStatusReason() *StatusReason

func (*PaymentResponse) GetSubscriptionID 

func (p *PaymentResponse) GetSubscriptionID() *string

func (*PaymentResponse) GetWebhookURL 

func (p *PaymentResponse) GetWebhookURL() *string

type PaymentResponseApplicationFee 

type PaymentResponseApplicationFee struct {
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount *Amount `json:"amount,omitempty"`
	// The description of the application fee. This will appear on settlement reports towards both you and the
	// connected merchant.
	Description *string `json:"description,omitempty"`
}

PaymentResponseApplicationFee - With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie merchants.

If you use OAuth to create payments on a connected merchant's account, you can charge a fee using this `applicationFee` parameter. If the payment succeeds, the fee will be deducted from the merchant's balance and sent to your own account balance.

If instead you want to split a payment on your own account between yourself and a connected merchant, refer to the `routing` parameter.

func (*PaymentResponseApplicationFee) GetAmount 

func (p *PaymentResponseApplicationFee) GetAmount() *Amount

func (*PaymentResponseApplicationFee) GetDescription 

func (p *PaymentResponseApplicationFee) GetDescription() *string

type PaymentResponseDetails 

type PaymentResponseDetails struct {
	// The customer's name, if made available by the payment method. For card payments, refer to details.cardHolder.
	ConsumerName *string `json:"consumerName,omitempty"`
	// The customer's account reference.
	//
	// For banking-based payment methods — such as iDEAL — this is normally either an IBAN or a domestic bank account
	// number.
	//
	// For PayPal, the account reference is an email address.
	//
	// For card and Bancontact payments, refer to details.cardNumber.
	ConsumerAccount *string `json:"consumerAccount,omitempty"`
	// The BIC of the customer's bank account, if applicable.
	ConsumerBic *string `json:"consumerBic,omitempty"`
	// For wallet payment methods — such as Apple Pay and PayPal — the shipping address is often already known by the
	// wallet provider. In these cases the shipping address may be available as a payment detail.
	ShippingAddress map[string]any `json:"shippingAddress,omitempty"`
	// For bancontact, it will be the customer's masked card number. For cards, it will be the last 4-digit of the
	// PAN. For Point-of-sale, it will be the the last 4 digits of the customer's masked card number.
	CardNumber *string `json:"cardNumber,omitempty"`
	// The name of the bank that the customer will need to make the bank transfer payment towards.
	BankName *string `json:"bankName,omitempty"`
	// The bank account number the customer will need to make the bank transfer payment towards.
	BankAccount *string `json:"bankAccount,omitempty"`
	// The BIC of the bank the customer will need to make the bank transfer payment towards.
	BankBic *string `json:"bankBic,omitempty"`
	// The Mollie-generated reference the customer needs to use when transfering the amount. Do not apply any
	// formatting here; show it to the customer as-is.
	TransferReference *string `json:"transferReference,omitempty"`
	// A unique fingerprint for a specific card. Can be used to identify returning customers.
	//
	// In the case of Point-of-sale payments, it's a unique identifier assigned to a cardholder's payment account,
	// linking multiple transactions from wallets and physical card to a single account, also across payment methods
	// or when the card is reissued.
	CardFingerprint *string `json:"cardFingerprint,omitempty"`
	// The customer's name as shown on their card.
	CardHolder *string `json:"cardHolder,omitempty"`
	// The card's target audience, if known.
	CardAudition *PaymentDetailsCardAuditionResponse `json:"cardAudition,omitempty"`
	// The card's label, if known.
	CardLabel *PaymentDetailsCardLabelResponse `json:"cardLabel,omitempty"`
	// The ISO 3166-1 alpha-2 country code of the country the card was issued in.
	CardCountryCode *string `json:"cardCountryCode,omitempty"`
	// The expiry date (MM/YY) of the card as displayed on the card.
	CardExpiryDate *string `json:"cardExpiryDate,omitempty"`
	// The card type.
	CardFunding *PaymentDetailsCardFundingResponse `json:"cardFunding,omitempty"`
	// The level of security applied during card processing.
	CardSecurity *PaymentDetailsCardSecurityResponse `json:"cardSecurity,omitempty"`
	// The applicable card fee region.
	FeeRegion *PaymentDetailsFeeRegionResponse `json:"feeRegion,omitempty"`
	// The first 6 and last 4 digits of the card number.
	CardMaskedNumber *string `json:"cardMaskedNumber,omitempty"`
	// The outcome of authentication attempted on transactions enforced by 3DS (ie valid only for oneoff and first).
	Card3dsEci *string `json:"card3dsEci,omitempty"`
	// The first 6 digit of the card bank identification number.
	CardBin *string `json:"cardBin,omitempty"`
	// The issuer of the Card.
	CardIssuer *string `json:"cardIssuer,omitempty"`
	// A failure code to help understand why the payment failed.
	FailureReason *PaymentDetailsFailureReasonResponse `json:"failureReason,omitempty"`
	// A human-friendly failure message that can be shown to the customer. The message is translated in accordance
	// with the payment's locale setting.
	FailureMessage *string `json:"failureMessage,omitempty"`
	// The wallet used when creating the payment.
	Wallet *PaymentDetailsWalletResponse `json:"wallet,omitempty"`
	// PayPal's reference for the payment.
	PaypalReference *string `json:"paypalReference,omitempty"`
	// ID of the customer's PayPal account.
	PaypalPayerID *string `json:"paypalPayerId,omitempty"`
	// Indicates to what extent the payment is eligible for PayPal's Seller Protection. Only available for PayPal
	// payments, and if the information is made available by PayPal.
	SellerProtection *PaymentDetailsSellerProtectionResponse `json:"sellerProtection,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	PaypalFee *AmountNullable `json:"paypalFee,omitempty"`
	// The paysafecard customer reference either provided via the API or otherwise auto-generated by Mollie.
	CustomerReference *string `json:"customerReference,omitempty"`
	// The ID of the terminal device where the payment took place on.
	TerminalID *string `json:"terminalId,omitempty"`
	// The first 6 digits & last 4 digits of the customer's masked card number.
	MaskedNumber *string `json:"maskedNumber,omitempty"`
	// The Point of sale receipt object.
	Receipt *Receipt `json:"receipt,omitempty"`
	// The creditor identifier indicates who is authorized to execute the payment. In this case, it is a
	// reference to Mollie.
	CreditorIdentifier *string `json:"creditorIdentifier,omitempty"`
	// Estimated date the payment is debited from the customer's bank account, in YYYY-MM-DD format.
	DueDate *types.Date `json:"dueDate,omitempty"`
	// Date the payment has been signed by the customer, in YYYY-MM-DD format. Only available if the payment
	// has been signed.
	SignatureDate *types.Date `json:"signatureDate,omitempty"`
	// The official reason why this payment has failed. A detailed description of each reason is available on the
	// website of the European Payments Council.
	BankReasonCode *string `json:"bankReasonCode,omitempty"`
	// A human-friendly description of the failure reason.
	BankReason *string `json:"bankReason,omitempty"`
	// The end-to-end identifier you provided in the batch file.
	EndToEndIdentifier *string `json:"endToEndIdentifier,omitempty"`
	// The mandate reference you provided in the batch file.
	MandateReference *string `json:"mandateReference,omitempty"`
	// The batch reference you provided in the batch file.
	BatchReference *string `json:"batchReference,omitempty"`
	// The file reference you provided in the batch file.
	FileReference *string `json:"fileReference,omitempty"`
	// Optional include. If a QR code was requested during payment creation for a QR-compatible payment method,
	// the QR code details will be available in this object.
	//
	// The QR code can be scanned by the customer to complete the payment on their mobile device. For example,
	// Bancontact QR payments can be completed by the customer using the Bancontact app.
	QrCode *QrCode `json:"qrCode,omitempty"`
	// For payments with gift cards: the masked gift card number of the first gift card applied to the payment.
	VoucherNumber *string `json:"voucherNumber,omitempty"`
	// An array of detail objects for each gift card that was used on this payment, if any.
	Giftcards []map[string]any `json:"giftcards,omitempty"`
	// For payments with vouchers: the brand name of the first voucher applied.
	Issuer *string `json:"issuer,omitempty"`
	// An array of detail objects for each voucher that was used on this payment, if any.
	Vouchers []map[string]any `json:"vouchers,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	RemainderAmount *Amount `json:"remainderAmount,omitempty"`
	// The payment method used to pay the remainder amount, after all gift cards or vouchers were applied.
	RemainderMethod *string `json:"remainderMethod,omitempty"`
	// Optional include. The full payment method details of the remainder payment.
	RemainderDetails map[string]any `json:"remainderDetails,omitempty"`
}

PaymentResponseDetails - An object containing payment details collected during the payment process. For example, details may include the customer's card or bank details and a payment reference. For the full list of details, please refer to the [method-specific parameters](extra-payment-parameters) guide.

func (*PaymentResponseDetails) GetBankAccount 

func (p *PaymentResponseDetails) GetBankAccount() *string

func (*PaymentResponseDetails) GetBankBic 

func (p *PaymentResponseDetails) GetBankBic() *string

func (*PaymentResponseDetails) GetBankName 

func (p *PaymentResponseDetails) GetBankName() *string

func (*PaymentResponseDetails) GetBankReason 

func (p *PaymentResponseDetails) GetBankReason() *string

func (*PaymentResponseDetails) GetBankReasonCode 

func (p *PaymentResponseDetails) GetBankReasonCode() *string

func (*PaymentResponseDetails) GetBatchReference 

func (p *PaymentResponseDetails) GetBatchReference() *string

func (*PaymentResponseDetails) GetCard3dsEci 

func (p *PaymentResponseDetails) GetCard3dsEci() *string

func (*PaymentResponseDetails) GetCardAudition 

func (p *PaymentResponseDetails) GetCardAudition() *PaymentDetailsCardAuditionResponse

func (*PaymentResponseDetails) GetCardBin 

func (p *PaymentResponseDetails) GetCardBin() *string

func (*PaymentResponseDetails) GetCardCountryCode 

func (p *PaymentResponseDetails) GetCardCountryCode() *string

func (*PaymentResponseDetails) GetCardExpiryDate 

func (p *PaymentResponseDetails) GetCardExpiryDate() *string

func (*PaymentResponseDetails) GetCardFingerprint 

func (p *PaymentResponseDetails) GetCardFingerprint() *string

func (*PaymentResponseDetails) GetCardFunding 

func (p *PaymentResponseDetails) GetCardFunding() *PaymentDetailsCardFundingResponse

func (*PaymentResponseDetails) GetCardHolder 

func (p *PaymentResponseDetails) GetCardHolder() *string

func (*PaymentResponseDetails) GetCardIssuer 

func (p *PaymentResponseDetails) GetCardIssuer() *string

func (*PaymentResponseDetails) GetCardLabel 

func (p *PaymentResponseDetails) GetCardLabel() *PaymentDetailsCardLabelResponse

func (*PaymentResponseDetails) GetCardMaskedNumber 

func (p *PaymentResponseDetails) GetCardMaskedNumber() *string

func (*PaymentResponseDetails) GetCardNumber 

func (p *PaymentResponseDetails) GetCardNumber() *string

func (*PaymentResponseDetails) GetCardSecurity 

func (p *PaymentResponseDetails) GetCardSecurity() *PaymentDetailsCardSecurityResponse

func (*PaymentResponseDetails) GetConsumerAccount 

func (p *PaymentResponseDetails) GetConsumerAccount() *string

func (*PaymentResponseDetails) GetConsumerBic 

func (p *PaymentResponseDetails) GetConsumerBic() *string

func (*PaymentResponseDetails) GetConsumerName 

func (p *PaymentResponseDetails) GetConsumerName() *string

func (*PaymentResponseDetails) GetCreditorIdentifier 

func (p *PaymentResponseDetails) GetCreditorIdentifier() *string

func (*PaymentResponseDetails) GetCustomerReference 

func (p *PaymentResponseDetails) GetCustomerReference() *string

func (*PaymentResponseDetails) GetDueDate 

func (p *PaymentResponseDetails) GetDueDate() *types.Date

func (*PaymentResponseDetails) GetEndToEndIdentifier 

func (p *PaymentResponseDetails) GetEndToEndIdentifier() *string

func (*PaymentResponseDetails) GetFailureMessage 

func (p *PaymentResponseDetails) GetFailureMessage() *string

func (*PaymentResponseDetails) GetFailureReason 

func (p *PaymentResponseDetails) GetFailureReason() *PaymentDetailsFailureReasonResponse

func (*PaymentResponseDetails) GetFeeRegion 

func (p *PaymentResponseDetails) GetFeeRegion() *PaymentDetailsFeeRegionResponse

func (*PaymentResponseDetails) GetFileReference 

func (p *PaymentResponseDetails) GetFileReference() *string

func (*PaymentResponseDetails) GetGiftcards 

func (p *PaymentResponseDetails) GetGiftcards() []map[string]any

func (*PaymentResponseDetails) GetIssuer 

func (p *PaymentResponseDetails) GetIssuer() *string

func (*PaymentResponseDetails) GetMandateReference 

func (p *PaymentResponseDetails) GetMandateReference() *string

func (*PaymentResponseDetails) GetMaskedNumber 

func (p *PaymentResponseDetails) GetMaskedNumber() *string

func (*PaymentResponseDetails) GetPaypalFee 

func (p *PaymentResponseDetails) GetPaypalFee() *AmountNullable

func (*PaymentResponseDetails) GetPaypalPayerID 

func (p *PaymentResponseDetails) GetPaypalPayerID() *string

func (*PaymentResponseDetails) GetPaypalReference 

func (p *PaymentResponseDetails) GetPaypalReference() *string

func (*PaymentResponseDetails) GetQrCode 

func (p *PaymentResponseDetails) GetQrCode() *QrCode

func (*PaymentResponseDetails) GetReceipt 

func (p *PaymentResponseDetails) GetReceipt() *Receipt

func (*PaymentResponseDetails) GetRemainderAmount 

func (p *PaymentResponseDetails) GetRemainderAmount() *Amount

func (*PaymentResponseDetails) GetRemainderDetails 

func (p *PaymentResponseDetails) GetRemainderDetails() map[string]any

func (*PaymentResponseDetails) GetRemainderMethod 

func (p *PaymentResponseDetails) GetRemainderMethod() *string

func (*PaymentResponseDetails) GetSellerProtection 

func (p *PaymentResponseDetails) GetSellerProtection() *PaymentDetailsSellerProtectionResponse

func (*PaymentResponseDetails) GetShippingAddress 

func (p *PaymentResponseDetails) GetShippingAddress() map[string]any

func (*PaymentResponseDetails) GetSignatureDate 

func (p *PaymentResponseDetails) GetSignatureDate() *types.Date

func (*PaymentResponseDetails) GetTerminalID 

func (p *PaymentResponseDetails) GetTerminalID() *string

func (*PaymentResponseDetails) GetTransferReference 

func (p *PaymentResponseDetails) GetTransferReference() *string

func (*PaymentResponseDetails) GetVoucherNumber 

func (p *PaymentResponseDetails) GetVoucherNumber() *string

func (*PaymentResponseDetails) GetVouchers 

func (p *PaymentResponseDetails) GetVouchers() []map[string]any

func (*PaymentResponseDetails) GetWallet 

func (p *PaymentResponseDetails) GetWallet() *PaymentDetailsWalletResponse

func (PaymentResponseDetails) MarshalJSON 

func (p PaymentResponseDetails) MarshalJSON() ([]byte, error)

func (*PaymentResponseDetails) UnmarshalJSON 

func (p *PaymentResponseDetails) UnmarshalJSON(data []byte) error

type PaymentResponseLine 

type PaymentResponseLine struct {
	// The type of product purchased. For example, a physical or a digital product.
	//
	// The `tip` payment line type is not available when creating a payment.
	Type *PaymentLineTypeResponse `json:"type,omitempty"`
	// A description of the line item. For example *LEGO 4440 Forest Police Station*.
	Description string `json:"description"`
	// The number of items.
	Quantity int64 `json:"quantity"`
	// The unit for the quantity. For example *pcs*, *kg*, or *cm*.
	QuantityUnit *string `json:"quantityUnit,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	UnitPrice Amount `json:"unitPrice"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	DiscountAmount *Amount `json:"discountAmount,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	TotalAmount Amount `json:"totalAmount"`
	// The VAT rate applied to the line, for example `21.00` for 21%. The vatRate should be passed as a string and
	// not as a float, to ensure the correct number of decimals are passed.
	VatRate *string `json:"vatRate,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	VatAmount *Amount `json:"vatAmount,omitempty"`
	// The SKU, EAN, ISBN or UPC of the product sold.
	Sku *string `json:"sku,omitempty"`
	// An array with the voucher categories, in case of a line eligible for a voucher. See the
	// [Integrating Vouchers](https://docs.mollie.com/docs/integrating-vouchers/) guide for more information.
	Categories []LineCategoriesResponse `json:"categories,omitempty"`
	// A link pointing to an image of the product sold.
	ImageURL *string `json:"imageUrl,omitempty"`
	// A link pointing to the product page in your web shop of the product sold.
	ProductURL *string            `json:"productUrl,omitempty"`
	Recurring  *RecurringLineItem `json:"recurring,omitempty"`
}

func (*PaymentResponseLine) GetCategories 

func (p *PaymentResponseLine) GetCategories() []LineCategoriesResponse

func (*PaymentResponseLine) GetDescription 

func (p *PaymentResponseLine) GetDescription() string

func (*PaymentResponseLine) GetDiscountAmount 

func (p *PaymentResponseLine) GetDiscountAmount() *Amount

func (*PaymentResponseLine) GetImageURL 

func (p *PaymentResponseLine) GetImageURL() *string

func (*PaymentResponseLine) GetProductURL 

func (p *PaymentResponseLine) GetProductURL() *string

func (*PaymentResponseLine) GetQuantity 

func (p *PaymentResponseLine) GetQuantity() int64

func (*PaymentResponseLine) GetQuantityUnit 

func (p *PaymentResponseLine) GetQuantityUnit() *string

func (*PaymentResponseLine) GetRecurring 

func (p *PaymentResponseLine) GetRecurring() *RecurringLineItem

func (*PaymentResponseLine) GetSku 

func (p *PaymentResponseLine) GetSku() *string

func (*PaymentResponseLine) GetTotalAmount 

func (p *PaymentResponseLine) GetTotalAmount() Amount

func (*PaymentResponseLine) GetType 

func (p *PaymentResponseLine) GetType() *PaymentLineTypeResponse

func (*PaymentResponseLine) GetUnitPrice 

func (p *PaymentResponseLine) GetUnitPrice() Amount

func (*PaymentResponseLine) GetVatAmount 

func (p *PaymentResponseLine) GetVatAmount() *Amount

func (*PaymentResponseLine) GetVatRate 

func (p *PaymentResponseLine) GetVatRate() *string
type PaymentResponseLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self URLObj `json:"self"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Checkout *URLObj `json:"checkout,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	MobileAppCheckout *URLObj `json:"mobileAppCheckout,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	ChangePaymentState *URLObj `json:"changePaymentState,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Dashboard URLObj `json:"dashboard"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Refunds *URLObj `json:"refunds,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Chargebacks *URLObj `json:"chargebacks,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Captures *URLObj `json:"captures,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Settlement *URLObj `json:"settlement,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Customer *URLObj `json:"customer,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Mandate *URLObj `json:"mandate,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Subscription *URLObj `json:"subscription,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Order *URLObj `json:"order,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Terminal *URLObj `json:"terminal,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation *URLObj `json:"documentation,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Status *URLObj `json:"status,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	PayOnline *URLObj `json:"payOnline,omitempty"`
}

PaymentResponseLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.

func (*PaymentResponseLinks) GetCaptures 

func (p *PaymentResponseLinks) GetCaptures() *URLObj

func (*PaymentResponseLinks) GetChangePaymentState 

func (p *PaymentResponseLinks) GetChangePaymentState() *URLObj

func (*PaymentResponseLinks) GetChargebacks 

func (p *PaymentResponseLinks) GetChargebacks() *URLObj

func (*PaymentResponseLinks) GetCheckout 

func (p *PaymentResponseLinks) GetCheckout() *URLObj

func (*PaymentResponseLinks) GetCustomer 

func (p *PaymentResponseLinks) GetCustomer() *URLObj

func (*PaymentResponseLinks) GetDashboard 

func (p *PaymentResponseLinks) GetDashboard() URLObj

func (*PaymentResponseLinks) GetDocumentation 

func (p *PaymentResponseLinks) GetDocumentation() *URLObj

func (*PaymentResponseLinks) GetMandate 

func (p *PaymentResponseLinks) GetMandate() *URLObj

func (*PaymentResponseLinks) GetMobileAppCheckout 

func (p *PaymentResponseLinks) GetMobileAppCheckout() *URLObj

func (*PaymentResponseLinks) GetOrder 

func (p *PaymentResponseLinks) GetOrder() *URLObj

func (*PaymentResponseLinks) GetPayOnline 

func (p *PaymentResponseLinks) GetPayOnline() *URLObj

func (*PaymentResponseLinks) GetRefunds 

func (p *PaymentResponseLinks) GetRefunds() *URLObj

func (*PaymentResponseLinks) GetSelf 

func (p *PaymentResponseLinks) GetSelf() URLObj

func (*PaymentResponseLinks) GetSettlement 

func (p *PaymentResponseLinks) GetSettlement() *URLObj

func (*PaymentResponseLinks) GetStatus 

func (p *PaymentResponseLinks) GetStatus() *URLObj

func (*PaymentResponseLinks) GetSubscription 

func (p *PaymentResponseLinks) GetSubscription() *URLObj

func (*PaymentResponseLinks) GetTerminal 

func (p *PaymentResponseLinks) GetTerminal() *URLObj

type PaymentStatus 

type PaymentStatus string

PaymentStatus - The payment's status. Refer to the [documentation regarding statuses](https://docs.mollie.com/docs/status-change#/) for more info about which statuses occur at what point. 

const (
	PaymentStatusOpen       PaymentStatus = "open"
	PaymentStatusPending    PaymentStatus = "pending"
	PaymentStatusAuthorized PaymentStatus = "authorized"
	PaymentStatusPaid       PaymentStatus = "paid"
	PaymentStatusCanceled   PaymentStatus = "canceled"
	PaymentStatusExpired    PaymentStatus = "expired"
	PaymentStatusFailed     PaymentStatus = "failed"
)

func (PaymentStatus) ToPointer 

func (e PaymentStatus) ToPointer() *PaymentStatus

type Payments 

type Payments struct {
	Pending              *SubGroup `json:"pending,omitempty"`
	MovedToAvailable     *SubGroup `json:"movedToAvailable,omitempty"`
	ImmediatelyAvailable *SubGroup `json:"immediatelyAvailable,omitempty"`
}

Payments - Only available on `transaction-categories` grouping.

func (*Payments) GetImmediatelyAvailable 

func (p *Payments) GetImmediatelyAvailable() *SubGroup

func (*Payments) GetMovedToAvailable 

func (p *Payments) GetMovedToAvailable() *SubGroup

func (*Payments) GetPending 

func (p *Payments) GetPending() *SubGroup

type PendingBalance 

type PendingBalance struct {
	Open             *SubGroup `json:"open,omitempty"`
	Close            *SubGroup `json:"close,omitempty"`
	Pending          *SubGroup `json:"pending,omitempty"`
	MovedToAvailable *SubGroup `json:"movedToAvailable,omitempty"`
}

PendingBalance - The pending balance. Only available if grouping is `status-balances`.

func (*PendingBalance) GetClose 

func (p *PendingBalance) GetClose() *SubGroup

func (*PendingBalance) GetMovedToAvailable 

func (p *PendingBalance) GetMovedToAvailable() *SubGroup

func (*PendingBalance) GetOpen 

func (p *PendingBalance) GetOpen() *SubGroup

func (*PendingBalance) GetPending 

func (p *PendingBalance) GetPending() *SubGroup

type Periods added in v0.4.2 

type Periods struct {
	// An array of cost objects, describing the fees withheld for each payment method during this period.
	Costs []Cost `json:"costs,omitempty"`
	// An array of revenue objects containing the total revenue for each payment method during this period.
	Revenue   []Revenue `json:"revenue,omitempty"`
	InvoiceID *string   `json:"invoiceId,omitempty"`
	// The invoice reference, if the invoice has been created already.
	InvoiceReference *string `json:"invoiceReference,omitempty"`
}

func (*Periods) GetCosts added in v0.4.2 

func (p *Periods) GetCosts() []Cost

func (*Periods) GetInvoiceID added in v0.4.2 

func (p *Periods) GetInvoiceID() *string

func (*Periods) GetInvoiceReference added in v0.4.2 

func (p *Periods) GetInvoiceReference() *string

func (*Periods) GetRevenue added in v0.4.2 

func (p *Periods) GetRevenue() []Revenue

type PlatformPaymentChargeback 

type PlatformPaymentChargeback struct {
	PaymentID             *string `json:"paymentId,omitempty"`
	PaymentDescription    *string `json:"paymentDescription,omitempty"`
	ChargebackID          *string `json:"chargebackId,omitempty"`
	ChargebackDescription *string `json:"chargebackDescription,omitempty"`
}

func (*PlatformPaymentChargeback) GetChargebackDescription 

func (p *PlatformPaymentChargeback) GetChargebackDescription() *string

func (*PlatformPaymentChargeback) GetChargebackID 

func (p *PlatformPaymentChargeback) GetChargebackID() *string

func (*PlatformPaymentChargeback) GetPaymentDescription 

func (p *PlatformPaymentChargeback) GetPaymentDescription() *string

func (*PlatformPaymentChargeback) GetPaymentID 

func (p *PlatformPaymentChargeback) GetPaymentID() *string

type PlatformPaymentRefund 

type PlatformPaymentRefund struct {
	PaymentID          *string `json:"paymentId,omitempty"`
	PaymentDescription *string `json:"paymentDescription,omitempty"`
	RefundID           *string `json:"refundId,omitempty"`
	RefundDescription  *string `json:"refundDescription,omitempty"`
}

func (*PlatformPaymentRefund) GetPaymentDescription 

func (p *PlatformPaymentRefund) GetPaymentDescription() *string

func (*PlatformPaymentRefund) GetPaymentID 

func (p *PlatformPaymentRefund) GetPaymentID() *string

func (*PlatformPaymentRefund) GetRefundDescription 

func (p *PlatformPaymentRefund) GetRefundDescription() *string

func (*PlatformPaymentRefund) GetRefundID 

func (p *PlatformPaymentRefund) GetRefundID() *string

type PostPaymentSplitPayment 

type PostPaymentSplitPayment struct {
	PaymentID *string `json:"paymentId,omitempty"`
}

func (*PostPaymentSplitPayment) GetPaymentID 

func (p *PostPaymentSplitPayment) GetPaymentID() *string

type Pricing 

type Pricing struct {
	// A description of what the pricing applies to. For example, a specific country (`The Netherlands`) or a
	// category of cards (`American Express`). If a `locale` is provided, the description may be translated.
	Description string `json:"description"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Fixed Amount `json:"fixed"`
	// The variable price charged per payment, as a percentage string.
	Variable string `json:"variable"`
	// Only present for credit card pricing. It will correspond with the `feeRegion` of credit card payments as
	// returned in the [Payments API](get-payment).
	FeeRegion *string `json:"feeRegion,omitempty"`
}

func (*Pricing) GetDescription 

func (p *Pricing) GetDescription() string

func (*Pricing) GetFeeRegion 

func (p *Pricing) GetFeeRegion() *string

func (*Pricing) GetFixed 

func (p *Pricing) GetFixed() Amount

func (*Pricing) GetVariable 

func (p *Pricing) GetVariable() string

type ProfileReviewStatusResponse 

type ProfileReviewStatusResponse string

ProfileReviewStatusResponse - The status of the requested changes. 

const (
	ProfileReviewStatusResponsePending  ProfileReviewStatusResponse = "pending"
	ProfileReviewStatusResponseRejected ProfileReviewStatusResponse = "rejected"
)

func (ProfileReviewStatusResponse) ToPointer 

func (e ProfileReviewStatusResponse) ToPointer() *ProfileReviewStatusResponse

type ProfileStatus 

type ProfileStatus string

ProfileStatus - The profile status determines whether the profile is able to receive live payments.

* `unverified`: The profile has not been verified yet and can only be used to create test payments. * `verified`: The profile has been verified and can be used to create live payments and test payments. * `blocked`: The profile is blocked and can no longer be used or changed. 

const (
	ProfileStatusUnverified ProfileStatus = "unverified"
	ProfileStatusVerified   ProfileStatus = "verified"
	ProfileStatusBlocked    ProfileStatus = "blocked"
)

func (ProfileStatus) ToPointer 

func (e ProfileStatus) ToPointer() *ProfileStatus

type QrCode 

type QrCode struct {
	// The height of the QR code image in pixels.
	Height *int64 `json:"height,omitempty"`
	// The width of the QR code image in pixels.
	Width *int64 `json:"width,omitempty"`
	// The URL to the QR code image. The image is a PNG file, and can be displayed directly in the browser or
	// downloaded.
	Src *string `json:"src,omitempty"`
}

QrCode - Optional include. If a QR code was requested during payment creation for a QR-compatible payment method, the QR code details will be available in this object.

The QR code can be scanned by the customer to complete the payment on their mobile device. For example, Bancontact QR payments can be completed by the customer using the Bancontact app.

func (*QrCode) GetHeight 

func (q *QrCode) GetHeight() *int64

func (*QrCode) GetSrc 

func (q *QrCode) GetSrc() *string

func (*QrCode) GetWidth 

func (q *QrCode) GetWidth() *int64

type Rate added in v0.4.2 

type Rate struct {
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Fixed      *Amount `json:"fixed,omitempty"`
	Percentage *string `json:"percentage,omitempty"`
}

Rate - The service rates, further divided into `fixed` and `percentage` costs.

func (*Rate) GetFixed added in v0.4.2 

func (r *Rate) GetFixed() *Amount

func (*Rate) GetPercentage added in v0.4.2 

func (r *Rate) GetPercentage() *string

type Reason 

type Reason struct {
	// Technical code provided by the bank.
	Code string `json:"code"`
	// A more detailed human-friendly description.
	Description string `json:"description"`
}

Reason for the chargeback as given by the bank. Only available for chargebacks of SEPA Direct Debit payments.

func (*Reason) GetCode 

func (r *Reason) GetCode() string

func (*Reason) GetDescription 

func (r *Reason) GetDescription() string

type Receipt 

type Receipt struct {
	// A unique code provided by the cardholder’s bank to confirm that the transaction was successfully approved.
	AuthorizationCode *string `json:"authorizationCode,omitempty"`
	// The unique number that identifies a specific payment application on a chip card.
	ApplicationIdentifier *string `json:"applicationIdentifier,omitempty"`
	// The method by which the card was read by the terminal.
	CardReadMethod *PaymentDetailsReceiptCardReadMethodResponse `json:"cardReadMethod,omitempty"`
	// The method used to verify the cardholder's identity.
	CardVerificationMethod *PaymentDetailsReceiptCardVerificationMethodResponse `json:"cardVerificationMethod,omitempty"`
}

Receipt - The Point of sale receipt object.

func (*Receipt) GetApplicationIdentifier 

func (r *Receipt) GetApplicationIdentifier() *string

func (*Receipt) GetAuthorizationCode 

func (r *Receipt) GetAuthorizationCode() *string

func (*Receipt) GetCardReadMethod 

func (r *Receipt) GetCardReadMethod() *PaymentDetailsReceiptCardReadMethodResponse

func (*Receipt) GetCardVerificationMethod 

func (r *Receipt) GetCardVerificationMethod() *PaymentDetailsReceiptCardVerificationMethodResponse

type RecurringLineItem 

type RecurringLineItem struct {
	// A description of the recurring item. If not present, the main description of the item will be used.
	Description *string `json:"description,omitempty"`
	// Cadence unit of the recurring item. For example: `12 months`, `52 weeks` or `365 days`.
	//
	// Possible values: `... days`, `... weeks`, `... months`.
	Interval string `json:"interval"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount *Amount `json:"amount,omitempty"`
	// Total number of charges for the subscription to complete. Leave empty for ongoing subscription.
	Times *int64 `json:"times,omitempty"`
	// The start date of the subscription if it does not start right away (format `YYYY-MM-DD`)
	StartDate *string `json:"startDate,omitempty"`
}

func (*RecurringLineItem) GetAmount 

func (r *RecurringLineItem) GetAmount() *Amount

func (*RecurringLineItem) GetDescription 

func (r *RecurringLineItem) GetDescription() *string

func (*RecurringLineItem) GetInterval 

func (r *RecurringLineItem) GetInterval() string

func (*RecurringLineItem) GetStartDate 

func (r *RecurringLineItem) GetStartDate() *string

func (*RecurringLineItem) GetTimes 

func (r *RecurringLineItem) GetTimes() *int64

type Refund 

type Refund struct {
	PaymentID          *string `json:"paymentId,omitempty"`
	PaymentDescription *string `json:"paymentDescription,omitempty"`
	RefundID           *string `json:"refundId,omitempty"`
	RefundDescription  *string `json:"refundDescription,omitempty"`
}

func (*Refund) GetPaymentDescription 

func (r *Refund) GetPaymentDescription() *string

func (*Refund) GetPaymentID 

func (r *Refund) GetPaymentID() *string

func (*Refund) GetRefundDescription 

func (r *Refund) GetRefundDescription() *string

func (*Refund) GetRefundID 

func (r *Refund) GetRefundID() *string

type RefundCompensation 

type RefundCompensation struct {
	PaymentID          *string `json:"paymentId,omitempty"`
	PaymentDescription *string `json:"paymentDescription,omitempty"`
	RefundID           *string `json:"refundId,omitempty"`
	RefundDescription  *string `json:"refundDescription,omitempty"`
}

func (*RefundCompensation) GetPaymentDescription 

func (r *RefundCompensation) GetPaymentDescription() *string

func (*RefundCompensation) GetPaymentID 

func (r *RefundCompensation) GetPaymentID() *string

func (*RefundCompensation) GetRefundDescription 

func (r *RefundCompensation) GetRefundDescription() *string

func (*RefundCompensation) GetRefundID 

func (r *RefundCompensation) GetRefundID() *string

type RefundExternalReferenceType 

type RefundExternalReferenceType string

RefundExternalReferenceType - Specifies the reference type 

const (
	RefundExternalReferenceTypeAcquirerReference RefundExternalReferenceType = "acquirer-reference"
)

func (RefundExternalReferenceType) ToPointer 

func (e RefundExternalReferenceType) ToPointer() *RefundExternalReferenceType

func (*RefundExternalReferenceType) UnmarshalJSON 

func (e *RefundExternalReferenceType) UnmarshalJSON(data []byte) error

type RefundExternalReferenceTypeResponse 

type RefundExternalReferenceTypeResponse string

RefundExternalReferenceTypeResponse - Specifies the reference type 

const (
	RefundExternalReferenceTypeResponseAcquirerReference RefundExternalReferenceTypeResponse = "acquirer-reference"
)

func (RefundExternalReferenceTypeResponse) ToPointer 

func (e RefundExternalReferenceTypeResponse) ToPointer() *RefundExternalReferenceTypeResponse

type RefundRoutingReversalsSourceType 

type RefundRoutingReversalsSourceType string

RefundRoutingReversalsSourceType - The type of source. Currently only the source type `organization` is supported. 

const (
	RefundRoutingReversalsSourceTypeOrganization RefundRoutingReversalsSourceType = "organization"
)

func (RefundRoutingReversalsSourceType) ToPointer 

func (e RefundRoutingReversalsSourceType) ToPointer() *RefundRoutingReversalsSourceType

func (*RefundRoutingReversalsSourceType) UnmarshalJSON 

func (e *RefundRoutingReversalsSourceType) UnmarshalJSON(data []byte) error

type RefundStatus 

type RefundStatus string
const (
	RefundStatusQueued     RefundStatus = "queued"
	RefundStatusPending    RefundStatus = "pending"
	RefundStatusProcessing RefundStatus = "processing"
	RefundStatusRefunded   RefundStatus = "refunded"
	RefundStatusFailed     RefundStatus = "failed"
	RefundStatusCanceled   RefundStatus = "canceled"
)

func (RefundStatus) ToPointer 

func (e RefundStatus) ToPointer() *RefundStatus

type Refunds 

type Refunds struct {
	Pending              *SubGroup `json:"pending,omitempty"`
	MovedToAvailable     *SubGroup `json:"movedToAvailable,omitempty"`
	ImmediatelyAvailable *SubGroup `json:"immediatelyAvailable,omitempty"`
}

Refunds - Only available on `transaction-categories` grouping.

func (*Refunds) GetImmediatelyAvailable 

func (r *Refunds) GetImmediatelyAvailable() *SubGroup

func (*Refunds) GetMovedToAvailable 

func (r *Refunds) GetMovedToAvailable() *SubGroup

func (*Refunds) GetPending 

func (r *Refunds) GetPending() *SubGroup

type ReimbursementFee 

type ReimbursementFee struct {
	PaymentID          *string `json:"paymentId,omitempty"`
	PaymentDescription *string `json:"paymentDescription,omitempty"`
}

func (*ReimbursementFee) GetPaymentDescription 

func (r *ReimbursementFee) GetPaymentDescription() *string

func (*ReimbursementFee) GetPaymentID 

func (r *ReimbursementFee) GetPaymentID() *string

type ReturnedManagedFee 

type ReturnedManagedFee struct {
	FeeType *string `json:"feeType,omitempty"`
	FeeID   *string `json:"feeId,omitempty"`
}

func (*ReturnedManagedFee) GetFeeID 

func (r *ReturnedManagedFee) GetFeeID() *string

func (*ReturnedManagedFee) GetFeeType 

func (r *ReturnedManagedFee) GetFeeType() *string

type ReturnedPlatformPaymentRefund 

type ReturnedPlatformPaymentRefund struct {
	PaymentID          *string `json:"paymentId,omitempty"`
	PaymentDescription *string `json:"paymentDescription,omitempty"`
	RefundID           *string `json:"refundId,omitempty"`
	RefundDescription  *string `json:"refundDescription,omitempty"`
}

func (*ReturnedPlatformPaymentRefund) GetPaymentDescription 

func (r *ReturnedPlatformPaymentRefund) GetPaymentDescription() *string

func (*ReturnedPlatformPaymentRefund) GetPaymentID 

func (r *ReturnedPlatformPaymentRefund) GetPaymentID() *string

func (*ReturnedPlatformPaymentRefund) GetRefundDescription 

func (r *ReturnedPlatformPaymentRefund) GetRefundDescription() *string

func (*ReturnedPlatformPaymentRefund) GetRefundID 

func (r *ReturnedPlatformPaymentRefund) GetRefundID() *string

type ReturnedRefund 

type ReturnedRefund struct {
	PaymentID          *string `json:"paymentId,omitempty"`
	PaymentDescription *string `json:"paymentDescription,omitempty"`
	RefundID           *string `json:"refundId,omitempty"`
	RefundDescription  *string `json:"refundDescription,omitempty"`
}

func (*ReturnedRefund) GetPaymentDescription 

func (r *ReturnedRefund) GetPaymentDescription() *string

func (*ReturnedRefund) GetPaymentID 

func (r *ReturnedRefund) GetPaymentID() *string

func (*ReturnedRefund) GetRefundDescription 

func (r *ReturnedRefund) GetRefundDescription() *string

func (*ReturnedRefund) GetRefundID 

func (r *ReturnedRefund) GetRefundID() *string

type ReturnedRefundCompensation 

type ReturnedRefundCompensation struct {
	PaymentID          *string `json:"paymentId,omitempty"`
	PaymentDescription *string `json:"paymentDescription,omitempty"`
	RefundID           *string `json:"refundId,omitempty"`
	RefundDescription  *string `json:"refundDescription,omitempty"`
}

func (*ReturnedRefundCompensation) GetPaymentDescription 

func (r *ReturnedRefundCompensation) GetPaymentDescription() *string

func (*ReturnedRefundCompensation) GetPaymentID 

func (r *ReturnedRefundCompensation) GetPaymentID() *string

func (*ReturnedRefundCompensation) GetRefundDescription 

func (r *ReturnedRefundCompensation) GetRefundDescription() *string

func (*ReturnedRefundCompensation) GetRefundID 

func (r *ReturnedRefundCompensation) GetRefundID() *string

type ReturnedTransfer 

type ReturnedTransfer struct {
	TransferID   *string `json:"transferId,omitempty"`
	SettlementID *string `json:"settlementId,omitempty"`
}

func (*ReturnedTransfer) GetSettlementID 

func (r *ReturnedTransfer) GetSettlementID() *string

func (*ReturnedTransfer) GetTransferID 

func (r *ReturnedTransfer) GetTransferID() *string

type Revenue added in v0.4.2 

type Revenue struct {
	// A description of the revenue subtotal
	Description string `json:"description"`
	// The payment method, if applicable
	Method *PaymentMethod `json:"method"`
	// The number of payments
	Count int64 `json:"count"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	AmountNet Amount `json:"amountNet"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	AmountVat *AmountNullable `json:"amountVat"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	AmountGross Amount `json:"amountGross"`
}

func (*Revenue) GetAmountGross added in v0.4.2 

func (r *Revenue) GetAmountGross() Amount

func (*Revenue) GetAmountNet added in v0.4.2 

func (r *Revenue) GetAmountNet() Amount

func (*Revenue) GetAmountVat added in v0.4.2 

func (r *Revenue) GetAmountVat() *AmountNullable

func (*Revenue) GetCount added in v0.4.2 

func (r *Revenue) GetCount() int64

func (*Revenue) GetDescription added in v0.4.2 

func (r *Revenue) GetDescription() string

func (*Revenue) GetMethod added in v0.4.2 

func (r *Revenue) GetMethod() *PaymentMethod

type ReversedChargebackCompensation 

type ReversedChargebackCompensation struct {
	PaymentID             *string `json:"paymentId,omitempty"`
	PaymentDescription    *string `json:"paymentDescription,omitempty"`
	ChargebackID          *string `json:"chargebackId,omitempty"`
	ChargebackDescription *string `json:"chargebackDescription,omitempty"`
}

func (*ReversedChargebackCompensation) GetChargebackDescription 

func (r *ReversedChargebackCompensation) GetChargebackDescription() *string

func (*ReversedChargebackCompensation) GetChargebackID 

func (r *ReversedChargebackCompensation) GetChargebackID() *string

func (*ReversedChargebackCompensation) GetPaymentDescription 

func (r *ReversedChargebackCompensation) GetPaymentDescription() *string

func (*ReversedChargebackCompensation) GetPaymentID 

func (r *ReversedChargebackCompensation) GetPaymentID() *string

type ReversedPlatformPaymentChargeback 

type ReversedPlatformPaymentChargeback struct {
	PaymentID             *string `json:"paymentId,omitempty"`
	PaymentDescription    *string `json:"paymentDescription,omitempty"`
	ChargebackID          *string `json:"chargebackId,omitempty"`
	ChargebackDescription *string `json:"chargebackDescription,omitempty"`
}

func (*ReversedPlatformPaymentChargeback) GetChargebackDescription 

func (r *ReversedPlatformPaymentChargeback) GetChargebackDescription() *string

func (*ReversedPlatformPaymentChargeback) GetChargebackID 

func (r *ReversedPlatformPaymentChargeback) GetChargebackID() *string

func (*ReversedPlatformPaymentChargeback) GetPaymentDescription 

func (r *ReversedPlatformPaymentChargeback) GetPaymentDescription() *string

func (*ReversedPlatformPaymentChargeback) GetPaymentID 

func (r *ReversedPlatformPaymentChargeback) GetPaymentID() *string

type Review 

type Review struct {
	// The status of the requested changes.
	Status *ProfileReviewStatusResponse `json:"status,omitempty"`
}

Review - Present if changes have been made that have not yet been approved by Mollie. Changes to test profiles are approved automatically, unless a switch to a live profile has been requested. The review object will therefore usually be `null` in test mode.

func (*Review) GetStatus 

func (r *Review) GetStatus() *ProfileReviewStatusResponse

func (Review) MarshalJSON 

func (r Review) MarshalJSON() ([]byte, error)

func (*Review) UnmarshalJSON 

func (r *Review) UnmarshalJSON(data []byte) error

type RouteCreateRequest 

type RouteCreateRequest struct {
	ID        *string `json:"id,omitempty"`
	PaymentID *string `json:"paymentId,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount *Amount `json:"amount,omitempty"`
	// The description of the route. This description is shown in the reports.
	Description *string `json:"description,omitempty"`
	// The destination of the route.
	Destination *RouteCreateRequestDestination `json:"destination,omitempty"`
	// Whether to create the entity in test mode or live mode.
	//
	// Most API credentials are specifically created for either live mode or test mode, in which case this parameter can be
	// omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting
	// `testmode` to `true`.
	Testmode *bool `json:"testmode,omitempty"`
}

func (*RouteCreateRequest) GetAmount 

func (r *RouteCreateRequest) GetAmount() *Amount

func (*RouteCreateRequest) GetDescription 

func (r *RouteCreateRequest) GetDescription() *string

func (*RouteCreateRequest) GetDestination 

func (r *RouteCreateRequest) GetDestination() *RouteCreateRequestDestination

func (*RouteCreateRequest) GetID 

func (r *RouteCreateRequest) GetID() *string

func (*RouteCreateRequest) GetPaymentID 

func (r *RouteCreateRequest) GetPaymentID() *string

func (*RouteCreateRequest) GetTestmode 

func (r *RouteCreateRequest) GetTestmode() *bool

type RouteCreateRequestDestination 

type RouteCreateRequestDestination struct {
	// The type of destination. Currently only the destination type `organization` is supported.
	Type           RouteDestinationType `json:"type"`
	OrganizationID string               `json:"organizationId"`
}

RouteCreateRequestDestination - The destination of the route.

func (*RouteCreateRequestDestination) GetOrganizationID 

func (r *RouteCreateRequestDestination) GetOrganizationID() string

func (*RouteCreateRequestDestination) GetType 

func (r *RouteCreateRequestDestination) GetType() RouteDestinationType

type RouteCreateResponse 

type RouteCreateResponse struct {
	// Indicates the response contains a route object. Will always contain the string `route` for this endpoint.
	Resource  string `json:"resource"`
	ID        string `json:"id"`
	PaymentID string `json:"paymentId"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount Amount `json:"amount"`
	// The description of the route. This description is shown in the reports.
	Description string `json:"description"`
	// The destination of the route.
	Destination RouteCreateResponseDestination `json:"destination"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links RouteCreateResponseLinks `json:"_links"`
}

func (*RouteCreateResponse) GetAmount 

func (r *RouteCreateResponse) GetAmount() Amount

func (*RouteCreateResponse) GetDescription 

func (r *RouteCreateResponse) GetDescription() string

func (*RouteCreateResponse) GetDestination 

func (r *RouteCreateResponse) GetDestination() RouteCreateResponseDestination

func (*RouteCreateResponse) GetID 

func (r *RouteCreateResponse) GetID() string
func (r *RouteCreateResponse) GetLinks() RouteCreateResponseLinks

func (*RouteCreateResponse) GetPaymentID 

func (r *RouteCreateResponse) GetPaymentID() string

func (*RouteCreateResponse) GetResource 

func (r *RouteCreateResponse) GetResource() string

type RouteCreateResponseDestination 

type RouteCreateResponseDestination struct {
	// The type of destination. Currently only the destination type `organization` is supported.
	Type           RouteDestinationTypeResponse `json:"type"`
	OrganizationID string                       `json:"organizationId"`
}

RouteCreateResponseDestination - The destination of the route.

func (*RouteCreateResponseDestination) GetOrganizationID 

func (r *RouteCreateResponseDestination) GetOrganizationID() string

func (*RouteCreateResponseDestination) GetType 

func (r *RouteCreateResponseDestination) GetType() RouteDestinationTypeResponse
type RouteCreateResponseLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self URLObj `json:"self"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation URLObj `json:"documentation"`
}

RouteCreateResponseLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.

func (*RouteCreateResponseLinks) GetDocumentation 

func (r *RouteCreateResponseLinks) GetDocumentation() URLObj

func (*RouteCreateResponseLinks) GetSelf 

func (r *RouteCreateResponseLinks) GetSelf() URLObj

type RouteDestinationType 

type RouteDestinationType string

RouteDestinationType - The type of destination. Currently only the destination type `organization` is supported. 

const (
	RouteDestinationTypeOrganization RouteDestinationType = "organization"
)

func (RouteDestinationType) ToPointer 

func (e RouteDestinationType) ToPointer() *RouteDestinationType

func (*RouteDestinationType) UnmarshalJSON 

func (e *RouteDestinationType) UnmarshalJSON(data []byte) error

type RouteDestinationTypeResponse 

type RouteDestinationTypeResponse string

RouteDestinationTypeResponse - The type of destination. Currently only the destination type `organization` is supported. 

const (
	RouteDestinationTypeResponseOrganization RouteDestinationTypeResponse = "organization"
)

func (RouteDestinationTypeResponse) ToPointer 

func (e RouteDestinationTypeResponse) ToPointer() *RouteDestinationTypeResponse

type RouteGetResponse 

type RouteGetResponse struct {
	// Indicates the response contains a route object. Will always contain the string `route` for this endpoint.
	Resource  string `json:"resource"`
	ID        string `json:"id"`
	PaymentID string `json:"paymentId"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount Amount `json:"amount"`
	// The description of the route. This description is shown in the reports.
	Description string `json:"description"`
	// The destination of the route.
	Destination RouteGetResponseDestination `json:"destination"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links RouteGetResponseLinks `json:"_links"`
	// The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	CreatedAt string `json:"createdAt"`
}

func (*RouteGetResponse) GetAmount 

func (r *RouteGetResponse) GetAmount() Amount

func (*RouteGetResponse) GetCreatedAt 

func (r *RouteGetResponse) GetCreatedAt() string

func (*RouteGetResponse) GetDescription 

func (r *RouteGetResponse) GetDescription() string

func (*RouteGetResponse) GetDestination 

func (r *RouteGetResponse) GetDestination() RouteGetResponseDestination

func (*RouteGetResponse) GetID 

func (r *RouteGetResponse) GetID() string
func (r *RouteGetResponse) GetLinks() RouteGetResponseLinks

func (*RouteGetResponse) GetPaymentID 

func (r *RouteGetResponse) GetPaymentID() string

func (*RouteGetResponse) GetResource 

func (r *RouteGetResponse) GetResource() string

type RouteGetResponseDestination 

type RouteGetResponseDestination struct {
	// The type of destination. Currently only the destination type `organization` is supported.
	Type           RouteDestinationTypeResponse `json:"type"`
	OrganizationID string                       `json:"organizationId"`
}

RouteGetResponseDestination - The destination of the route.

func (*RouteGetResponseDestination) GetOrganizationID 

func (r *RouteGetResponseDestination) GetOrganizationID() string

func (*RouteGetResponseDestination) GetType 

func (r *RouteGetResponseDestination) GetType() RouteDestinationTypeResponse
type RouteGetResponseLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self URLObj `json:"self"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation URLObj `json:"documentation"`
}

RouteGetResponseLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.

func (*RouteGetResponseLinks) GetDocumentation 

func (r *RouteGetResponseLinks) GetDocumentation() URLObj

func (*RouteGetResponseLinks) GetSelf 

func (r *RouteGetResponseLinks) GetSelf() URLObj

type SalesInvoiceDiscount 

type SalesInvoiceDiscount struct {
	// The type of discount.
	Type SalesInvoiceDiscountType `json:"type"`
	// A string containing an exact monetary amount in the given currency, or the percentage.
	Value string `json:"value"`
}

func (*SalesInvoiceDiscount) GetType 

func (s *SalesInvoiceDiscount) GetType() SalesInvoiceDiscountType

func (*SalesInvoiceDiscount) GetValue 

func (s *SalesInvoiceDiscount) GetValue() string

type SalesInvoiceDiscountResponse 

type SalesInvoiceDiscountResponse struct {
	// The type of discount.
	Type SalesInvoiceDiscountTypeResponse `json:"type"`
	// A string containing an exact monetary amount in the given currency, or the percentage.
	Value string `json:"value"`
}

func (*SalesInvoiceDiscountResponse) GetType 

func (s *SalesInvoiceDiscountResponse) GetType() SalesInvoiceDiscountTypeResponse

func (*SalesInvoiceDiscountResponse) GetValue 

func (s *SalesInvoiceDiscountResponse) GetValue() string

type SalesInvoiceDiscountType 

type SalesInvoiceDiscountType string

SalesInvoiceDiscountType - The type of discount. 

const (
	SalesInvoiceDiscountTypeAmount     SalesInvoiceDiscountType = "amount"
	SalesInvoiceDiscountTypePercentage SalesInvoiceDiscountType = "percentage"
)

func (SalesInvoiceDiscountType) ToPointer 

func (e SalesInvoiceDiscountType) ToPointer() *SalesInvoiceDiscountType

func (*SalesInvoiceDiscountType) UnmarshalJSON 

func (e *SalesInvoiceDiscountType) UnmarshalJSON(data []byte) error

type SalesInvoiceDiscountTypeResponse 

type SalesInvoiceDiscountTypeResponse string

SalesInvoiceDiscountTypeResponse - The type of discount. 

const (
	SalesInvoiceDiscountTypeResponseAmount     SalesInvoiceDiscountTypeResponse = "amount"
	SalesInvoiceDiscountTypeResponsePercentage SalesInvoiceDiscountTypeResponse = "percentage"
)

func (SalesInvoiceDiscountTypeResponse) ToPointer 

func (e SalesInvoiceDiscountTypeResponse) ToPointer() *SalesInvoiceDiscountTypeResponse

type SalesInvoiceEmailDetails 

type SalesInvoiceEmailDetails struct {
	// The subject of the email to be sent.
	Subject string `json:"subject"`
	// The body of the email to be sent. To add newline characters, you can use `\n`.
	Body string `json:"body"`
}

func (*SalesInvoiceEmailDetails) GetBody 

func (s *SalesInvoiceEmailDetails) GetBody() string

func (*SalesInvoiceEmailDetails) GetSubject 

func (s *SalesInvoiceEmailDetails) GetSubject() string

type SalesInvoiceLineItem 

type SalesInvoiceLineItem struct {
	// A description of the line item. For example *LEGO 4440 Forest Police Station*.
	Description string `json:"description"`
	// The number of items.
	Quantity int64 `json:"quantity"`
	// The vat rate to be applied to this line item.
	VatRate string `json:"vatRate"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	UnitPrice Amount                `json:"unitPrice"`
	Discount  *SalesInvoiceDiscount `json:"discount,omitempty"`
}

func (*SalesInvoiceLineItem) GetDescription 

func (s *SalesInvoiceLineItem) GetDescription() string

func (*SalesInvoiceLineItem) GetDiscount 

func (s *SalesInvoiceLineItem) GetDiscount() *SalesInvoiceDiscount

func (*SalesInvoiceLineItem) GetQuantity 

func (s *SalesInvoiceLineItem) GetQuantity() int64

func (*SalesInvoiceLineItem) GetUnitPrice 

func (s *SalesInvoiceLineItem) GetUnitPrice() Amount

func (*SalesInvoiceLineItem) GetVatRate 

func (s *SalesInvoiceLineItem) GetVatRate() string

type SalesInvoiceLineItemResponse 

type SalesInvoiceLineItemResponse struct {
	// A description of the line item. For example *LEGO 4440 Forest Police Station*.
	Description string `json:"description"`
	// The number of items.
	Quantity int64 `json:"quantity"`
	// The vat rate to be applied to this line item.
	VatRate string `json:"vatRate"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	UnitPrice Amount                        `json:"unitPrice"`
	Discount  *SalesInvoiceDiscountResponse `json:"discount,omitempty"`
}

func (*SalesInvoiceLineItemResponse) GetDescription 

func (s *SalesInvoiceLineItemResponse) GetDescription() string

func (*SalesInvoiceLineItemResponse) GetDiscount 

func (s *SalesInvoiceLineItemResponse) GetDiscount() *SalesInvoiceDiscountResponse

func (*SalesInvoiceLineItemResponse) GetQuantity 

func (s *SalesInvoiceLineItemResponse) GetQuantity() int64

func (*SalesInvoiceLineItemResponse) GetUnitPrice 

func (s *SalesInvoiceLineItemResponse) GetUnitPrice() Amount

func (*SalesInvoiceLineItemResponse) GetVatRate 

func (s *SalesInvoiceLineItemResponse) GetVatRate() string

type SalesInvoicePaymentDetails 

type SalesInvoicePaymentDetails struct {
	// The way through which the invoice is to be set to paid.
	Source SalesInvoicePaymentDetailsSource `json:"source"`
	// A reference to the payment the sales invoice is paid by. Required for `source` values `payment-link` and
	// `payment`.
	SourceReference *string `json:"sourceReference,omitempty"`
}

func (*SalesInvoicePaymentDetails) GetSource 

func (s *SalesInvoicePaymentDetails) GetSource() SalesInvoicePaymentDetailsSource

func (*SalesInvoicePaymentDetails) GetSourceReference 

func (s *SalesInvoicePaymentDetails) GetSourceReference() *string

type SalesInvoicePaymentDetailsResponse 

type SalesInvoicePaymentDetailsResponse struct {
	// The way through which the invoice is to be set to paid.
	Source SalesInvoicePaymentDetailsSourceResponse `json:"source"`
	// A reference to the payment the sales invoice is paid by. Required for `source` values `payment-link` and
	// `payment`.
	SourceReference *string `json:"sourceReference,omitempty"`
}

func (*SalesInvoicePaymentDetailsResponse) GetSource 

func (s *SalesInvoicePaymentDetailsResponse) GetSource() SalesInvoicePaymentDetailsSourceResponse

func (*SalesInvoicePaymentDetailsResponse) GetSourceReference 

func (s *SalesInvoicePaymentDetailsResponse) GetSourceReference() *string

type SalesInvoicePaymentDetailsSource 

type SalesInvoicePaymentDetailsSource string

SalesInvoicePaymentDetailsSource - The way through which the invoice is to be set to paid. 

const (
	SalesInvoicePaymentDetailsSourceManual      SalesInvoicePaymentDetailsSource = "manual"
	SalesInvoicePaymentDetailsSourcePaymentLink SalesInvoicePaymentDetailsSource = "payment-link"
	SalesInvoicePaymentDetailsSourcePayment     SalesInvoicePaymentDetailsSource = "payment"
)

func (SalesInvoicePaymentDetailsSource) ToPointer 

func (e SalesInvoicePaymentDetailsSource) ToPointer() *SalesInvoicePaymentDetailsSource

func (*SalesInvoicePaymentDetailsSource) UnmarshalJSON 

func (e *SalesInvoicePaymentDetailsSource) UnmarshalJSON(data []byte) error

type SalesInvoicePaymentDetailsSourceResponse 

type SalesInvoicePaymentDetailsSourceResponse string

SalesInvoicePaymentDetailsSourceResponse - The way through which the invoice is to be set to paid. 

const (
	SalesInvoicePaymentDetailsSourceResponseManual      SalesInvoicePaymentDetailsSourceResponse = "manual"
	SalesInvoicePaymentDetailsSourceResponsePaymentLink SalesInvoicePaymentDetailsSourceResponse = "payment-link"
	SalesInvoicePaymentDetailsSourceResponsePayment     SalesInvoicePaymentDetailsSourceResponse = "payment"
)

func (SalesInvoicePaymentDetailsSourceResponse) ToPointer 

func (e SalesInvoicePaymentDetailsSourceResponse) ToPointer() *SalesInvoicePaymentDetailsSourceResponse

type SalesInvoicePaymentTerm 

type SalesInvoicePaymentTerm string

SalesInvoicePaymentTerm - The payment term to be set on the invoice. 

const (
	SalesInvoicePaymentTermSevendays               SalesInvoicePaymentTerm = "7 days"
	SalesInvoicePaymentTermFourteendays            SalesInvoicePaymentTerm = "14 days"
	SalesInvoicePaymentTermThirtydays              SalesInvoicePaymentTerm = "30 days"
	SalesInvoicePaymentTermFortyFivedays           SalesInvoicePaymentTerm = "45 days"
	SalesInvoicePaymentTermSixtydays               SalesInvoicePaymentTerm = "60 days"
	SalesInvoicePaymentTermNinetydays              SalesInvoicePaymentTerm = "90 days"
	SalesInvoicePaymentTermOneHundredAndTwentydays SalesInvoicePaymentTerm = "120 days"
)

func (SalesInvoicePaymentTerm) ToPointer 

func (e SalesInvoicePaymentTerm) ToPointer() *SalesInvoicePaymentTerm

func (*SalesInvoicePaymentTerm) UnmarshalJSON 

func (e *SalesInvoicePaymentTerm) UnmarshalJSON(data []byte) error

type SalesInvoicePaymentTermResponse 

type SalesInvoicePaymentTermResponse string

SalesInvoicePaymentTermResponse - The payment term to be set on the invoice. 

const (
	SalesInvoicePaymentTermResponseSevendays               SalesInvoicePaymentTermResponse = "7 days"
	SalesInvoicePaymentTermResponseFourteendays            SalesInvoicePaymentTermResponse = "14 days"
	SalesInvoicePaymentTermResponseThirtydays              SalesInvoicePaymentTermResponse = "30 days"
	SalesInvoicePaymentTermResponseFortyFivedays           SalesInvoicePaymentTermResponse = "45 days"
	SalesInvoicePaymentTermResponseSixtydays               SalesInvoicePaymentTermResponse = "60 days"
	SalesInvoicePaymentTermResponseNinetydays              SalesInvoicePaymentTermResponse = "90 days"
	SalesInvoicePaymentTermResponseOneHundredAndTwentydays SalesInvoicePaymentTermResponse = "120 days"
)

func (SalesInvoicePaymentTermResponse) ToPointer 

func (e SalesInvoicePaymentTermResponse) ToPointer() *SalesInvoicePaymentTermResponse

type SalesInvoiceRecipient 

type SalesInvoiceRecipient struct {
	// The type of recipient, either `consumer` or `business`. This will determine what further fields are
	// required on the `recipient` object.
	Type SalesInvoiceRecipientType `json:"type"`
	// The title of the `consumer` type recipient, for example Mr. or Mrs..
	Title *string `json:"title,omitempty"`
	// The given name (first name) of the `consumer` type recipient should be at least two characters and cannot contain
	// only numbers.
	GivenName *string `json:"givenName,omitempty"`
	// The given name (last name) of the `consumer` type recipient should be at least two characters and cannot contain
	// only numbers.
	FamilyName *string `json:"familyName,omitempty"`
	// The trading name of the `business` type recipient.
	OrganizationName *string `json:"organizationName,omitempty"`
	// The Chamber of Commerce number of the organization for a `business` type recipient. Either this or `vatNumber`
	// has to be provided.
	OrganizationNumber *string `json:"organizationNumber,omitempty"`
	// The VAT number of the organization for a `business` type recipient. Either this or `organizationNumber`
	// has to be provided.
	VatNumber *string `json:"vatNumber,omitempty"`
	// The email address of the recipient.
	Email string `json:"email"`
	// The phone number of the recipient.
	Phone *string `json:"phone,omitempty"`
	// A street and street number.
	StreetAndNumber string `json:"streetAndNumber"`
	// Any additional addressing details, for example an apartment number.
	StreetAdditional *string `json:"streetAdditional,omitempty"`
	// A postal code.
	PostalCode string `json:"postalCode"`
	// The recipient's city.
	City string `json:"city"`
	// The recipient's region.
	Region *string `json:"region,omitempty"`
	// A country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
	Country string `json:"country"`
	// The locale for the recipient, to be used for translations in PDF generation and payment pages.
	Locale SalesInvoiceRecipientLocale `json:"locale"`
}

func (*SalesInvoiceRecipient) GetCity 

func (s *SalesInvoiceRecipient) GetCity() string

func (*SalesInvoiceRecipient) GetCountry 

func (s *SalesInvoiceRecipient) GetCountry() string

func (*SalesInvoiceRecipient) GetEmail 

func (s *SalesInvoiceRecipient) GetEmail() string

func (*SalesInvoiceRecipient) GetFamilyName 

func (s *SalesInvoiceRecipient) GetFamilyName() *string

func (*SalesInvoiceRecipient) GetGivenName 

func (s *SalesInvoiceRecipient) GetGivenName() *string

func (*SalesInvoiceRecipient) GetLocale 

func (s *SalesInvoiceRecipient) GetLocale() SalesInvoiceRecipientLocale

func (*SalesInvoiceRecipient) GetOrganizationName 

func (s *SalesInvoiceRecipient) GetOrganizationName() *string

func (*SalesInvoiceRecipient) GetOrganizationNumber 

func (s *SalesInvoiceRecipient) GetOrganizationNumber() *string

func (*SalesInvoiceRecipient) GetPhone 

func (s *SalesInvoiceRecipient) GetPhone() *string

func (*SalesInvoiceRecipient) GetPostalCode 

func (s *SalesInvoiceRecipient) GetPostalCode() string

func (*SalesInvoiceRecipient) GetRegion 

func (s *SalesInvoiceRecipient) GetRegion() *string

func (*SalesInvoiceRecipient) GetStreetAdditional 

func (s *SalesInvoiceRecipient) GetStreetAdditional() *string

func (*SalesInvoiceRecipient) GetStreetAndNumber 

func (s *SalesInvoiceRecipient) GetStreetAndNumber() string

func (*SalesInvoiceRecipient) GetTitle 

func (s *SalesInvoiceRecipient) GetTitle() *string

func (*SalesInvoiceRecipient) GetType 

func (s *SalesInvoiceRecipient) GetType() SalesInvoiceRecipientType

func (*SalesInvoiceRecipient) GetVatNumber 

func (s *SalesInvoiceRecipient) GetVatNumber() *string

type SalesInvoiceRecipientLocale 

type SalesInvoiceRecipientLocale string

SalesInvoiceRecipientLocale - The locale for the recipient, to be used for translations in PDF generation and payment pages. 

const (
	SalesInvoiceRecipientLocaleEnUs SalesInvoiceRecipientLocale = "en_US"
	SalesInvoiceRecipientLocaleEnGb SalesInvoiceRecipientLocale = "en_GB"
	SalesInvoiceRecipientLocaleNlNl SalesInvoiceRecipientLocale = "nl_NL"
	SalesInvoiceRecipientLocaleNlBe SalesInvoiceRecipientLocale = "nl_BE"
	SalesInvoiceRecipientLocaleDeDe SalesInvoiceRecipientLocale = "de_DE"
	SalesInvoiceRecipientLocaleDeAt SalesInvoiceRecipientLocale = "de_AT"
	SalesInvoiceRecipientLocaleDeCh SalesInvoiceRecipientLocale = "de_CH"
	SalesInvoiceRecipientLocaleFrFr SalesInvoiceRecipientLocale = "fr_FR"
	SalesInvoiceRecipientLocaleFrBe SalesInvoiceRecipientLocale = "fr_BE"
)

func (SalesInvoiceRecipientLocale) ToPointer 

func (e SalesInvoiceRecipientLocale) ToPointer() *SalesInvoiceRecipientLocale

func (*SalesInvoiceRecipientLocale) UnmarshalJSON 

func (e *SalesInvoiceRecipientLocale) UnmarshalJSON(data []byte) error

type SalesInvoiceRecipientLocaleResponse 

type SalesInvoiceRecipientLocaleResponse string

SalesInvoiceRecipientLocaleResponse - The locale for the recipient, to be used for translations in PDF generation and payment pages. 

const (
	SalesInvoiceRecipientLocaleResponseEnUs SalesInvoiceRecipientLocaleResponse = "en_US"
	SalesInvoiceRecipientLocaleResponseEnGb SalesInvoiceRecipientLocaleResponse = "en_GB"
	SalesInvoiceRecipientLocaleResponseNlNl SalesInvoiceRecipientLocaleResponse = "nl_NL"
	SalesInvoiceRecipientLocaleResponseNlBe SalesInvoiceRecipientLocaleResponse = "nl_BE"
	SalesInvoiceRecipientLocaleResponseDeDe SalesInvoiceRecipientLocaleResponse = "de_DE"
	SalesInvoiceRecipientLocaleResponseDeAt SalesInvoiceRecipientLocaleResponse = "de_AT"
	SalesInvoiceRecipientLocaleResponseDeCh SalesInvoiceRecipientLocaleResponse = "de_CH"
	SalesInvoiceRecipientLocaleResponseFrFr SalesInvoiceRecipientLocaleResponse = "fr_FR"
	SalesInvoiceRecipientLocaleResponseFrBe SalesInvoiceRecipientLocaleResponse = "fr_BE"
)

func (SalesInvoiceRecipientLocaleResponse) ToPointer 

func (e SalesInvoiceRecipientLocaleResponse) ToPointer() *SalesInvoiceRecipientLocaleResponse

type SalesInvoiceRecipientResponse 

type SalesInvoiceRecipientResponse struct {
	// The type of recipient, either `consumer` or `business`. This will determine what further fields are
	// required on the `recipient` object.
	Type SalesInvoiceRecipientTypeResponse `json:"type"`
	// The title of the `consumer` type recipient, for example Mr. or Mrs..
	Title *string `json:"title,omitempty"`
	// The given name (first name) of the `consumer` type recipient should be at least two characters and cannot contain
	// only numbers.
	GivenName *string `json:"givenName,omitempty"`
	// The given name (last name) of the `consumer` type recipient should be at least two characters and cannot contain
	// only numbers.
	FamilyName *string `json:"familyName,omitempty"`
	// The trading name of the `business` type recipient.
	OrganizationName *string `json:"organizationName,omitempty"`
	// The Chamber of Commerce number of the organization for a `business` type recipient. Either this or `vatNumber`
	// has to be provided.
	OrganizationNumber *string `json:"organizationNumber,omitempty"`
	// The VAT number of the organization for a `business` type recipient. Either this or `organizationNumber`
	// has to be provided.
	VatNumber *string `json:"vatNumber,omitempty"`
	// The email address of the recipient.
	Email string `json:"email"`
	// The phone number of the recipient.
	Phone *string `json:"phone,omitempty"`
	// A street and street number.
	StreetAndNumber string `json:"streetAndNumber"`
	// Any additional addressing details, for example an apartment number.
	StreetAdditional *string `json:"streetAdditional,omitempty"`
	// A postal code.
	PostalCode string `json:"postalCode"`
	// The recipient's city.
	City string `json:"city"`
	// The recipient's region.
	Region *string `json:"region,omitempty"`
	// A country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
	Country string `json:"country"`
	// The locale for the recipient, to be used for translations in PDF generation and payment pages.
	Locale SalesInvoiceRecipientLocaleResponse `json:"locale"`
}

func (*SalesInvoiceRecipientResponse) GetCity 

func (s *SalesInvoiceRecipientResponse) GetCity() string

func (*SalesInvoiceRecipientResponse) GetCountry 

func (s *SalesInvoiceRecipientResponse) GetCountry() string

func (*SalesInvoiceRecipientResponse) GetEmail 

func (s *SalesInvoiceRecipientResponse) GetEmail() string

func (*SalesInvoiceRecipientResponse) GetFamilyName 

func (s *SalesInvoiceRecipientResponse) GetFamilyName() *string

func (*SalesInvoiceRecipientResponse) GetGivenName 

func (s *SalesInvoiceRecipientResponse) GetGivenName() *string

func (*SalesInvoiceRecipientResponse) GetLocale 

func (s *SalesInvoiceRecipientResponse) GetLocale() SalesInvoiceRecipientLocaleResponse

func (*SalesInvoiceRecipientResponse) GetOrganizationName 

func (s *SalesInvoiceRecipientResponse) GetOrganizationName() *string

func (*SalesInvoiceRecipientResponse) GetOrganizationNumber 

func (s *SalesInvoiceRecipientResponse) GetOrganizationNumber() *string

func (*SalesInvoiceRecipientResponse) GetPhone 

func (s *SalesInvoiceRecipientResponse) GetPhone() *string

func (*SalesInvoiceRecipientResponse) GetPostalCode 

func (s *SalesInvoiceRecipientResponse) GetPostalCode() string

func (*SalesInvoiceRecipientResponse) GetRegion 

func (s *SalesInvoiceRecipientResponse) GetRegion() *string

func (*SalesInvoiceRecipientResponse) GetStreetAdditional 

func (s *SalesInvoiceRecipientResponse) GetStreetAdditional() *string

func (*SalesInvoiceRecipientResponse) GetStreetAndNumber 

func (s *SalesInvoiceRecipientResponse) GetStreetAndNumber() string

func (*SalesInvoiceRecipientResponse) GetTitle 

func (s *SalesInvoiceRecipientResponse) GetTitle() *string

func (*SalesInvoiceRecipientResponse) GetType 

func (s *SalesInvoiceRecipientResponse) GetType() SalesInvoiceRecipientTypeResponse

func (*SalesInvoiceRecipientResponse) GetVatNumber 

func (s *SalesInvoiceRecipientResponse) GetVatNumber() *string

type SalesInvoiceRecipientType 

type SalesInvoiceRecipientType string

SalesInvoiceRecipientType - The type of recipient, either `consumer` or `business`. This will determine what further fields are required on the `recipient` object. 

const (
	SalesInvoiceRecipientTypeConsumer SalesInvoiceRecipientType = "consumer"
	SalesInvoiceRecipientTypeBusiness SalesInvoiceRecipientType = "business"
)

func (SalesInvoiceRecipientType) ToPointer 

func (e SalesInvoiceRecipientType) ToPointer() *SalesInvoiceRecipientType

func (*SalesInvoiceRecipientType) UnmarshalJSON 

func (e *SalesInvoiceRecipientType) UnmarshalJSON(data []byte) error

type SalesInvoiceRecipientTypeResponse 

type SalesInvoiceRecipientTypeResponse string

SalesInvoiceRecipientTypeResponse - The type of recipient, either `consumer` or `business`. This will determine what further fields are required on the `recipient` object. 

const (
	SalesInvoiceRecipientTypeResponseConsumer SalesInvoiceRecipientTypeResponse = "consumer"
	SalesInvoiceRecipientTypeResponseBusiness SalesInvoiceRecipientTypeResponse = "business"
)

func (SalesInvoiceRecipientTypeResponse) ToPointer 

func (e SalesInvoiceRecipientTypeResponse) ToPointer() *SalesInvoiceRecipientTypeResponse

type SalesInvoiceStatus 

type SalesInvoiceStatus string

SalesInvoiceStatus - The status for the invoice to end up in.

A `draft` invoice is not paid or not sent and can be updated after creation. Setting it to `issued` sends it to the recipient so they may then pay through our payment system. To skip our payment process, set this to `paid` to mark it as paid. It can then subsequently be sent as well, same as with `issued`.

A status value that cannot be set but can be returned is `canceled`, for invoices which were issued, but then canceled. Currently this can only be done for invoices created in the dashboard.

Dependent parameters:

  • `paymentDetails` is required if invoice should be set directly to `paid`
  • `customerId` and `mandateId` are required if a recurring payment should be used to set the invoice to `paid`
  • `emailDetails` optional for `issued` and `paid` to send the invoice by email
const (
	SalesInvoiceStatusDraft  SalesInvoiceStatus = "draft"
	SalesInvoiceStatusIssued SalesInvoiceStatus = "issued"
	SalesInvoiceStatusPaid   SalesInvoiceStatus = "paid"
)

func (SalesInvoiceStatus) ToPointer 

func (e SalesInvoiceStatus) ToPointer() *SalesInvoiceStatus

func (*SalesInvoiceStatus) UnmarshalJSON 

func (e *SalesInvoiceStatus) UnmarshalJSON(data []byte) error

type SalesInvoiceStatusResponse 

type SalesInvoiceStatusResponse string

SalesInvoiceStatusResponse - The status for the invoice to end up in.

A `draft` invoice is not paid or not sent and can be updated after creation. Setting it to `issued` sends it to the recipient so they may then pay through our payment system. To skip our payment process, set this to `paid` to mark it as paid. It can then subsequently be sent as well, same as with `issued`.

A status value that cannot be set but can be returned is `canceled`, for invoices which were issued, but then canceled. Currently this can only be done for invoices created in the dashboard.

Dependent parameters:

  • `paymentDetails` is required if invoice should be set directly to `paid`
  • `customerId` and `mandateId` are required if a recurring payment should be used to set the invoice to `paid`
  • `emailDetails` optional for `issued` and `paid` to send the invoice by email
const (
	SalesInvoiceStatusResponseDraft  SalesInvoiceStatusResponse = "draft"
	SalesInvoiceStatusResponseIssued SalesInvoiceStatusResponse = "issued"
	SalesInvoiceStatusResponsePaid   SalesInvoiceStatusResponse = "paid"
)

func (SalesInvoiceStatusResponse) ToPointer 

func (e SalesInvoiceStatusResponse) ToPointer() *SalesInvoiceStatusResponse

type SalesInvoiceVatMode 

type SalesInvoiceVatMode string

SalesInvoiceVatMode - The VAT mode to use for VAT calculation. `exclusive` mode means we will apply the relevant VAT on top of the price. `inclusive` means the prices you are providing to us already contain the VAT you want to apply. 

const (
	SalesInvoiceVatModeExclusive SalesInvoiceVatMode = "exclusive"
	SalesInvoiceVatModeInclusive SalesInvoiceVatMode = "inclusive"
)

func (SalesInvoiceVatMode) ToPointer 

func (e SalesInvoiceVatMode) ToPointer() *SalesInvoiceVatMode

func (*SalesInvoiceVatMode) UnmarshalJSON 

func (e *SalesInvoiceVatMode) UnmarshalJSON(data []byte) error

type SalesInvoiceVatModeResponse 

type SalesInvoiceVatModeResponse string

SalesInvoiceVatModeResponse - The VAT mode to use for VAT calculation. `exclusive` mode means we will apply the relevant VAT on top of the price. `inclusive` means the prices you are providing to us already contain the VAT you want to apply. 

const (
	SalesInvoiceVatModeResponseExclusive SalesInvoiceVatModeResponse = "exclusive"
	SalesInvoiceVatModeResponseInclusive SalesInvoiceVatModeResponse = "inclusive"
)

func (SalesInvoiceVatModeResponse) ToPointer 

func (e SalesInvoiceVatModeResponse) ToPointer() *SalesInvoiceVatModeResponse

type SalesInvoiceVatScheme 

type SalesInvoiceVatScheme string

SalesInvoiceVatScheme - The VAT scheme to create the invoice for. You must be enrolled with One Stop Shop enabled to use it. 

const (
	SalesInvoiceVatSchemeStandard    SalesInvoiceVatScheme = "standard"
	SalesInvoiceVatSchemeOneStopShop SalesInvoiceVatScheme = "one-stop-shop"
)

func (SalesInvoiceVatScheme) ToPointer 

func (e SalesInvoiceVatScheme) ToPointer() *SalesInvoiceVatScheme

func (*SalesInvoiceVatScheme) UnmarshalJSON 

func (e *SalesInvoiceVatScheme) UnmarshalJSON(data []byte) error

type SalesInvoiceVatSchemeResponse 

type SalesInvoiceVatSchemeResponse string

SalesInvoiceVatSchemeResponse - The VAT scheme to create the invoice for. You must be enrolled with One Stop Shop enabled to use it. 

const (
	SalesInvoiceVatSchemeResponseStandard    SalesInvoiceVatSchemeResponse = "standard"
	SalesInvoiceVatSchemeResponseOneStopShop SalesInvoiceVatSchemeResponse = "one-stop-shop"
)

func (SalesInvoiceVatSchemeResponse) ToPointer 

func (e SalesInvoiceVatSchemeResponse) ToPointer() *SalesInvoiceVatSchemeResponse

type Security 

type Security struct {
	APIKey *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=client_api_key"`
	OAuth  *string `security:"scheme,type=oauth2,name=Authorization,env=client_o_auth"`
}

func (*Security) GetAPIKey 

func (s *Security) GetAPIKey() *string

func (*Security) GetOAuth 

func (s *Security) GetOAuth() *string

type SequenceType 

type SequenceType string
const (
	SequenceTypeOneoff    SequenceType = "oneoff"
	SequenceTypeFirst     SequenceType = "first"
	SequenceTypeRecurring SequenceType = "recurring"
)

func (SequenceType) ToPointer 

func (e SequenceType) ToPointer() *SequenceType

func (*SequenceType) UnmarshalJSON 

func (e *SequenceType) UnmarshalJSON(data []byte) error

type SequenceTypeResponse 

type SequenceTypeResponse string
const (
	SequenceTypeResponseOneoff    SequenceTypeResponse = "oneoff"
	SequenceTypeResponseFirst     SequenceTypeResponse = "first"
	SequenceTypeResponseRecurring SequenceTypeResponse = "recurring"
)

func (SequenceTypeResponse) ToPointer 

func (e SequenceTypeResponse) ToPointer() *SequenceTypeResponse

type SettlementStatus 

type SettlementStatus string

SettlementStatus - The status of the settlement. 

const (
	SettlementStatusOpen    SettlementStatus = "open"
	SettlementStatusPending SettlementStatus = "pending"
	SettlementStatusPaidout SettlementStatus = "paidout"
	SettlementStatusFailed  SettlementStatus = "failed"
)

func (SettlementStatus) ToPointer 

func (e SettlementStatus) ToPointer() *SettlementStatus

type SplitPayment 

type SplitPayment struct {
	PaymentID          *string `json:"paymentId,omitempty"`
	PaymentDescription *string `json:"paymentDescription,omitempty"`
	PaymentOnwer       *string `json:"paymentOnwer,omitempty"`
}

func (*SplitPayment) GetPaymentDescription 

func (s *SplitPayment) GetPaymentDescription() *string

func (*SplitPayment) GetPaymentID 

func (s *SplitPayment) GetPaymentID() *string

func (*SplitPayment) GetPaymentOnwer 

func (s *SplitPayment) GetPaymentOnwer() *string

type StatusReason 

type StatusReason struct {
	Code Code `json:"code"`
	// A description of the status reason, localized according to the payment `locale`.
	Message string `json:"message"`
}

StatusReason - This object offers details about the status of a payment. Currently it is only available for point-of-sale payments.

You can find more information about the possible values of this object on [this page](status-reasons).**

func (*StatusReason) GetCode 

func (s *StatusReason) GetCode() Code

func (*StatusReason) GetMessage 

func (s *StatusReason) GetMessage() string

type SubGroup 

type SubGroup struct {
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount    *Amount               `json:"amount,omitempty"`
	Subtotals []ComponentsSubTotals `json:"subtotals,omitempty"`
}

func (*SubGroup) GetAmount 

func (s *SubGroup) GetAmount() *Amount

func (*SubGroup) GetSubtotals 

func (s *SubGroup) GetSubtotals() []ComponentsSubTotals

type SubTotals 

type SubTotals struct {
	// Number of transactions of this type
	Count *int64 `json:"count,omitempty"`
	// The payment method, if applicable
	Method *PaymentMethod `json:"method,omitempty"`
	// In case of payments transactions with card, the card issuer will be available
	CardIssuer *SubTotalsCardIssuer `json:"cardIssuer,omitempty"`
	// In case of payments trnsactions with card, the card audience will be available.
	CardAudience *SubTotalsCardAudience `json:"cardAudience,omitempty"`
	// In case of payments transactions with card, the card region will be available.
	CardRegion *SubTotalsCardRegion `json:"cardRegion,omitempty"`
	// Present when the transaction represents a fee.
	FeeType *SubTotalsFeeType `json:"feeType,omitempty"`
	// Prepayment part: fee itself, reimbursement, discount, VAT or rounding compensation.
	PrepaymentPartType *SubTotalsPrepaymentPartType `json:"prepaymentPartType,omitempty"`
	// Represents the transaction type
	TransactionType *SubTotalsTransactionType `json:"transactionType,omitempty"`
}

func (*SubTotals) GetCardAudience 

func (s *SubTotals) GetCardAudience() *SubTotalsCardAudience

func (*SubTotals) GetCardIssuer 

func (s *SubTotals) GetCardIssuer() *SubTotalsCardIssuer

func (*SubTotals) GetCardRegion 

func (s *SubTotals) GetCardRegion() *SubTotalsCardRegion

func (*SubTotals) GetCount 

func (s *SubTotals) GetCount() *int64

func (*SubTotals) GetFeeType 

func (s *SubTotals) GetFeeType() *SubTotalsFeeType

func (*SubTotals) GetMethod 

func (s *SubTotals) GetMethod() *PaymentMethod

func (*SubTotals) GetPrepaymentPartType 

func (s *SubTotals) GetPrepaymentPartType() *SubTotalsPrepaymentPartType

func (*SubTotals) GetTransactionType 

func (s *SubTotals) GetTransactionType() *SubTotalsTransactionType

type SubTotalsCardAudience 

type SubTotalsCardAudience string

SubTotalsCardAudience - In case of payments trnsactions with card, the card audience will be available. 

const (
	SubTotalsCardAudienceCorporate SubTotalsCardAudience = "corporate"
	SubTotalsCardAudienceOther     SubTotalsCardAudience = "other"
)

func (SubTotalsCardAudience) ToPointer 

func (e SubTotalsCardAudience) ToPointer() *SubTotalsCardAudience

func (*SubTotalsCardAudience) UnmarshalJSON 

func (e *SubTotalsCardAudience) UnmarshalJSON(data []byte) error

type SubTotalsCardIssuer 

type SubTotalsCardIssuer string

SubTotalsCardIssuer - In case of payments transactions with card, the card issuer will be available 

const (
	SubTotalsCardIssuerAmex          SubTotalsCardIssuer = "amex"
	SubTotalsCardIssuerMaestro       SubTotalsCardIssuer = "maestro"
	SubTotalsCardIssuerCarteBancaire SubTotalsCardIssuer = "carte-bancaire"
	SubTotalsCardIssuerOther         SubTotalsCardIssuer = "other"
)

func (SubTotalsCardIssuer) ToPointer 

func (e SubTotalsCardIssuer) ToPointer() *SubTotalsCardIssuer

func (*SubTotalsCardIssuer) UnmarshalJSON 

func (e *SubTotalsCardIssuer) UnmarshalJSON(data []byte) error

type SubTotalsCardRegion 

type SubTotalsCardRegion string

SubTotalsCardRegion - In case of payments transactions with card, the card region will be available. 

const (
	SubTotalsCardRegionIntraEea SubTotalsCardRegion = "intra-eea"
	SubTotalsCardRegionIntraEu  SubTotalsCardRegion = "intra-eu"
	SubTotalsCardRegionDomestic SubTotalsCardRegion = "domestic"
	SubTotalsCardRegionOther    SubTotalsCardRegion = "other"
)

func (SubTotalsCardRegion) ToPointer 

func (e SubTotalsCardRegion) ToPointer() *SubTotalsCardRegion

func (*SubTotalsCardRegion) UnmarshalJSON 

func (e *SubTotalsCardRegion) UnmarshalJSON(data []byte) error

type SubTotalsFeeType 

type SubTotalsFeeType string

SubTotalsFeeType - Present when the transaction represents a fee. 

const (
	SubTotalsFeeTypePaymentFee                                        SubTotalsFeeType = "payment-fee"
	SubTotalsFeeTypeDirectDebitFailureFee                             SubTotalsFeeType = "direct-debit-failure-fee"
	SubTotalsFeeTypeUnauthorizedDirectDebitFee                        SubTotalsFeeType = "unauthorized-direct-debit-fee"
	SubTotalsFeeTypeBankChargedDirectDebitFailureFee                  SubTotalsFeeType = "bank-charged-direct-debit-failure-fee"
	SubTotalsFeeTypePartnerCommission                                 SubTotalsFeeType = "partner-commission"
	SubTotalsFeeTypeApplicationFee                                    SubTotalsFeeType = "application-fee"
	SubTotalsFeeTypeCaptureFee                                        SubTotalsFeeType = "capture-fee"
	SubTotalsFeeTypeRefundFee                                         SubTotalsFeeType = "refund-fee"
	SubTotalsFeeTypeChargebackFee                                     SubTotalsFeeType = "chargeback-fee"
	SubTotalsFeeTypePaymentNotificationFee                            SubTotalsFeeType = "payment-notification-fee"
	SubTotalsFeeTypeTransferNotificationFee                           SubTotalsFeeType = "transfer-notification-fee"
	SubTotalsFeeTypePayoutFee                                         SubTotalsFeeType = "payout-fee"
	SubTotalsFeeTypeFeeDiscount                                       SubTotalsFeeType = "fee-discount"
	SubTotalsFeeTypeFeeReimbursement                                  SubTotalsFeeType = "fee-reimbursement"
	SubTotalsFeeTypePlatformVolumeFee                                 SubTotalsFeeType = "platform-volume-fee"
	SubTotalsFeeTypePlatformConnectedOrganizationsFee                 SubTotalsFeeType = "platform-connected-organizations-fee"
	SubTotalsFeeTypeBalanceChargeFee                                  SubTotalsFeeType = "balance-charge-fee"
	SubTotalsFeeTypeThreedsAuthenticationAttemptFee                   SubTotalsFeeType = "3ds-authentication-attempt-fee"
	SubTotalsFeeTypeTerminalMonthlyFee                                SubTotalsFeeType = "terminal-monthly-fee"
	SubTotalsFeeTypeAcceptanceRiskFee                                 SubTotalsFeeType = "acceptance-risk-fee"
	SubTotalsFeeTypeTopUpFee                                          SubTotalsFeeType = "top-up-fee"
	SubTotalsFeeTypePaymentGatewayFee                                 SubTotalsFeeType = "payment-gateway-fee"
	SubTotalsFeeTypeMastercardSpecialtyMerchantProgramProcessingFee   SubTotalsFeeType = "mastercard-specialty-merchant-program-processing-fee"
	SubTotalsFeeTypeMastercardSpecialtyMerchantProgramRegistrationFee SubTotalsFeeType = "mastercard-specialty-merchant-program-registration-fee"
	SubTotalsFeeTypeVisaIntegrityRiskProgramProcessingFee             SubTotalsFeeType = "visa-integrity-risk-program-processing-fee"
	SubTotalsFeeTypeVisaIntegrityRiskProgramRegistrationFee           SubTotalsFeeType = "visa-integrity-risk-program-registration-fee"
	SubTotalsFeeTypeMinimumInvoiceAmountFee                           SubTotalsFeeType = "minimum-invoice-amount-fee"
)

func (SubTotalsFeeType) ToPointer 

func (e SubTotalsFeeType) ToPointer() *SubTotalsFeeType

func (*SubTotalsFeeType) UnmarshalJSON 

func (e *SubTotalsFeeType) UnmarshalJSON(data []byte) error

type SubTotalsPrepaymentPartType 

type SubTotalsPrepaymentPartType string

SubTotalsPrepaymentPartType - Prepayment part: fee itself, reimbursement, discount, VAT or rounding compensation. 

const (
	SubTotalsPrepaymentPartTypeFee                     SubTotalsPrepaymentPartType = "fee"
	SubTotalsPrepaymentPartTypeFeeReimbursement        SubTotalsPrepaymentPartType = "fee-reimbursement"
	SubTotalsPrepaymentPartTypeFeeDiscount             SubTotalsPrepaymentPartType = "fee-discount"
	SubTotalsPrepaymentPartTypeFeeVat                  SubTotalsPrepaymentPartType = "fee-vat"
	SubTotalsPrepaymentPartTypeFeeRoundingCompensation SubTotalsPrepaymentPartType = "fee-rounding-compensation"
)

func (SubTotalsPrepaymentPartType) ToPointer 

func (e SubTotalsPrepaymentPartType) ToPointer() *SubTotalsPrepaymentPartType

func (*SubTotalsPrepaymentPartType) UnmarshalJSON 

func (e *SubTotalsPrepaymentPartType) UnmarshalJSON(data []byte) error

type SubTotalsTransactionType 

type SubTotalsTransactionType string

SubTotalsTransactionType - Represents the transaction type 

const (
	SubTotalsTransactionTypePayment                           SubTotalsTransactionType = "payment"
	SubTotalsTransactionTypeSplitPayment                      SubTotalsTransactionType = "split-payment"
	SubTotalsTransactionTypeFailedPayment                     SubTotalsTransactionType = "failed-payment"
	SubTotalsTransactionTypeFailedPlatformSplitPayment        SubTotalsTransactionType = "failed-platform-split-payment"
	SubTotalsTransactionTypeFailedSplitPaymentCompensation    SubTotalsTransactionType = "failed-split-payment-compensation"
	SubTotalsTransactionTypeCapture                           SubTotalsTransactionType = "capture"
	SubTotalsTransactionTypeSplitTransaction                  SubTotalsTransactionType = "split-transaction"
	SubTotalsTransactionTypeRefund                            SubTotalsTransactionType = "refund"
	SubTotalsTransactionTypePlatformPaymentRefund             SubTotalsTransactionType = "platform-payment-refund"
	SubTotalsTransactionTypeReturnedPlatformPaymentRefund     SubTotalsTransactionType = "returned-platform-payment-refund"
	SubTotalsTransactionTypeRefundCompensation                SubTotalsTransactionType = "refund-compensation"
	SubTotalsTransactionTypeReturnedRefundCompensation        SubTotalsTransactionType = "returned-refund-compensation"
	SubTotalsTransactionTypeReturnedRefund                    SubTotalsTransactionType = "returned-refund"
	SubTotalsTransactionTypeChargeback                        SubTotalsTransactionType = "chargeback"
	SubTotalsTransactionTypeChargebackReversal                SubTotalsTransactionType = "chargeback-reversal"
	SubTotalsTransactionTypeChargebackCompensation            SubTotalsTransactionType = "chargeback-compensation"
	SubTotalsTransactionTypeReversedChargebackCompensation    SubTotalsTransactionType = "reversed-chargeback-compensation"
	SubTotalsTransactionTypePlatformPaymentChargeback         SubTotalsTransactionType = "platform-payment-chargeback"
	SubTotalsTransactionTypeReversedPlatformPaymentChargeback SubTotalsTransactionType = "reversed-platform-payment-chargeback"
	SubTotalsTransactionTypeFeePrepayment                     SubTotalsTransactionType = "fee-prepayment"
	SubTotalsTransactionTypeOutgoingTransfer                  SubTotalsTransactionType = "outgoing-transfer"
	SubTotalsTransactionTypeIncomingTransfer                  SubTotalsTransactionType = "incoming-transfer"
	SubTotalsTransactionTypeCanceledTransfer                  SubTotalsTransactionType = "canceled-transfer"
	SubTotalsTransactionTypeReturnedTransfer                  SubTotalsTransactionType = "returned-transfer"
	SubTotalsTransactionTypeBalanceReserve                    SubTotalsTransactionType = "balance-reserve"
	SubTotalsTransactionTypeBalanceReserveReturn              SubTotalsTransactionType = "balance-reserve-return"
	SubTotalsTransactionTypeInvoiceRoundingCompensation       SubTotalsTransactionType = "invoice-rounding-compensation"
	SubTotalsTransactionTypeRollingReserveHold                SubTotalsTransactionType = "rolling-reserve-hold"
	SubTotalsTransactionTypeRollingReserveRelease             SubTotalsTransactionType = "rolling-reserve-release"
	SubTotalsTransactionTypeBalanceCorrection                 SubTotalsTransactionType = "balance-correction"
	SubTotalsTransactionTypeRepayment                         SubTotalsTransactionType = "repayment"
	SubTotalsTransactionTypeLoan                              SubTotalsTransactionType = "loan"
	SubTotalsTransactionTypeBalanceTopup                      SubTotalsTransactionType = "balance-topup"
	SubTotalsTransactionTypeCashCollateralIssuance            SubTotalsTransactionType = "cash-collateral-issuance';"
	SubTotalsTransactionTypeCashCollateralRelease             SubTotalsTransactionType = "cash-collateral-release"
	SubTotalsTransactionTypePendingRollingReserve             SubTotalsTransactionType = "pending-rolling-reserve"
	SubTotalsTransactionTypeToBeReleasedRollingReserve        SubTotalsTransactionType = "to-be-released-rolling-reserve"
	SubTotalsTransactionTypeHeldRollingReserve                SubTotalsTransactionType = "held-rolling-reserve"
	SubTotalsTransactionTypeReleasedRollingReserve            SubTotalsTransactionType = "released-rolling-reserve"
)

func (SubTotalsTransactionType) ToPointer 

func (e SubTotalsTransactionType) ToPointer() *SubTotalsTransactionType

func (*SubTotalsTransactionType) UnmarshalJSON 

func (e *SubTotalsTransactionType) UnmarshalJSON(data []byte) error

type SubscriptionMethod 

type SubscriptionMethod string

SubscriptionMethod - The payment method used for this subscription. If omitted, any of the customer's valid mandates may be used. 

const (
	SubscriptionMethodCreditcard  SubscriptionMethod = "creditcard"
	SubscriptionMethodDirectdebit SubscriptionMethod = "directdebit"
	SubscriptionMethodPaypal      SubscriptionMethod = "paypal"
)

func (SubscriptionMethod) ToPointer 

func (e SubscriptionMethod) ToPointer() *SubscriptionMethod

func (*SubscriptionMethod) UnmarshalJSON 

func (e *SubscriptionMethod) UnmarshalJSON(data []byte) error

type SubscriptionMethodResponse 

type SubscriptionMethodResponse string

SubscriptionMethodResponse - The payment method used for this subscription. If omitted, any of the customer's valid mandates may be used. 

const (
	SubscriptionMethodResponseCreditcard  SubscriptionMethodResponse = "creditcard"
	SubscriptionMethodResponseDirectdebit SubscriptionMethodResponse = "directdebit"
	SubscriptionMethodResponsePaypal      SubscriptionMethodResponse = "paypal"
)

func (SubscriptionMethodResponse) ToPointer 

func (e SubscriptionMethodResponse) ToPointer() *SubscriptionMethodResponse

type SubscriptionRequest 

type SubscriptionRequest struct {
	ID *string `json:"id,omitempty"`
	// The subscription's current status is directly related to the status of the underlying customer or mandate that is
	// enabling the subscription.
	Status *SubscriptionStatus `json:"status,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount *Amount `json:"amount,omitempty"`
	// Total number of payments for the subscription. Once this number of payments is reached, the subscription is
	// considered completed.
	//
	// Test mode subscriptions will get canceled automatically after 10 payments.
	Times *int64 `json:"times,omitempty"`
	// Interval to wait between payments, for example `1 month` or `14 days`.
	//
	// The maximum interval is one year (`12 months`, `52 weeks`, or `365 days`).
	//
	// Possible values: `... days`, `... weeks`, `... months`.
	Interval *string `json:"interval,omitempty"`
	// The start date of the subscription in `YYYY-MM-DD` format.
	StartDate *string `json:"startDate,omitempty"`
	// The subscription's description will be used as the description of the resulting individual payments and so showing
	// up on the bank statement of the consumer.
	//
	// **Please note:** the description needs to be unique for the Customer in case it has multiple active subscriptions.
	Description *string `json:"description,omitempty"`
	// The payment method used for this subscription. If omitted, any of the customer's valid mandates may be used.
	Method *SubscriptionMethod `json:"method,omitempty"`
	// With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie
	// merchants.
	//
	// Setting an application fee on the subscription will ensure this fee is charged on each individual payment.
	//
	// Refer to the `applicationFee` parameter on the [Get payment endpoint](get-payment) documentation for more
	// information.
	ApplicationFee *SubscriptionRequestApplicationFee `json:"applicationFee,omitempty"`
	// Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever
	// you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
	Metadata *Metadata `json:"metadata,omitempty"`
	// We will call this URL for any payment status changes of payments resulting from this subscription.
	//
	// This webhook will receive **all** events for the subscription's payments. This may include payment failures as
	// well. Be sure to verify the payment's subscription ID and its status.
	WebhookURL *string `json:"webhookUrl,omitempty"`
	CustomerID *string `json:"customerId,omitempty"`
	MandateID  *string `json:"mandateId,omitempty"`
	// Whether to create the entity in test mode or live mode.
	//
	// Most API credentials are specifically created for either live mode or test mode, in which case this parameter can be
	// omitted. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting
	// `testmode` to `true`.
	Testmode *bool `json:"testmode,omitempty"`
}

func (*SubscriptionRequest) GetAmount 

func (s *SubscriptionRequest) GetAmount() *Amount

func (*SubscriptionRequest) GetApplicationFee 

func (s *SubscriptionRequest) GetApplicationFee() *SubscriptionRequestApplicationFee

func (*SubscriptionRequest) GetCustomerID 

func (s *SubscriptionRequest) GetCustomerID() *string

func (*SubscriptionRequest) GetDescription 

func (s *SubscriptionRequest) GetDescription() *string

func (*SubscriptionRequest) GetID 

func (s *SubscriptionRequest) GetID() *string

func (*SubscriptionRequest) GetInterval 

func (s *SubscriptionRequest) GetInterval() *string

func (*SubscriptionRequest) GetMandateID 

func (s *SubscriptionRequest) GetMandateID() *string

func (*SubscriptionRequest) GetMetadata 

func (s *SubscriptionRequest) GetMetadata() *Metadata

func (*SubscriptionRequest) GetMethod 

func (s *SubscriptionRequest) GetMethod() *SubscriptionMethod

func (*SubscriptionRequest) GetStartDate 

func (s *SubscriptionRequest) GetStartDate() *string

func (*SubscriptionRequest) GetStatus 

func (s *SubscriptionRequest) GetStatus() *SubscriptionStatus

func (*SubscriptionRequest) GetTestmode 

func (s *SubscriptionRequest) GetTestmode() *bool

func (*SubscriptionRequest) GetTimes 

func (s *SubscriptionRequest) GetTimes() *int64

func (*SubscriptionRequest) GetWebhookURL 

func (s *SubscriptionRequest) GetWebhookURL() *string

type SubscriptionRequestApplicationFee 

type SubscriptionRequestApplicationFee struct {
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount      Amount `json:"amount"`
	Description string `json:"description"`
}

SubscriptionRequestApplicationFee - With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie merchants.

Setting an application fee on the subscription will ensure this fee is charged on each individual payment.

Refer to the `applicationFee` parameter on the [Get payment endpoint](get-payment) documentation for more information.

func (*SubscriptionRequestApplicationFee) GetAmount 

func (s *SubscriptionRequestApplicationFee) GetAmount() Amount

func (*SubscriptionRequestApplicationFee) GetDescription 

func (s *SubscriptionRequestApplicationFee) GetDescription() string

type SubscriptionResponse 

type SubscriptionResponse struct {
	// Indicates the response contains a subscription object. Will always contain the string `subscription` for this
	// endpoint.
	Resource *string `json:"resource,omitempty"`
	ID       *string `json:"id,omitempty"`
	// Whether this entity was created in live mode or in test mode.
	Mode *Mode `json:"mode,omitempty"`
	// The subscription's current status is directly related to the status of the underlying customer or mandate that is
	// enabling the subscription.
	Status *SubscriptionStatus `json:"status,omitempty"`
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount *Amount `json:"amount,omitempty"`
	// Total number of payments for the subscription. Once this number of payments is reached, the subscription is
	// considered completed.
	//
	// Test mode subscriptions will get canceled automatically after 10 payments.
	Times *int64 `json:"times,omitempty"`
	// Number of payments left for the subscription.
	TimesRemaining *int64 `json:"timesRemaining,omitempty"`
	// Interval to wait between payments, for example `1 month` or `14 days`.
	//
	// The maximum interval is one year (`12 months`, `52 weeks`, or `365 days`).
	//
	// Possible values: `... days`, `... weeks`, `... months`.
	Interval *string `json:"interval,omitempty"`
	// The start date of the subscription in `YYYY-MM-DD` format.
	StartDate *string `json:"startDate,omitempty"`
	// The date of the next scheduled payment in `YYYY-MM-DD` format. If the subscription has been completed or canceled,
	// this parameter will not be returned.
	NextPaymentDate *string `json:"nextPaymentDate,omitempty"`
	// The subscription's description will be used as the description of the resulting individual payments and so showing
	// up on the bank statement of the consumer.
	//
	// **Please note:** the description needs to be unique for the Customer in case it has multiple active subscriptions.
	Description *string `json:"description,omitempty"`
	// The payment method used for this subscription. If omitted, any of the customer's valid mandates may be used.
	Method *SubscriptionMethodResponse `json:"method,omitempty"`
	// With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie
	// merchants.
	//
	// Setting an application fee on the subscription will ensure this fee is charged on each individual payment.
	//
	// Refer to the `applicationFee` parameter on the [Get payment endpoint](get-payment) documentation for more
	// information.
	ApplicationFee *SubscriptionResponseApplicationFee `json:"applicationFee,omitempty"`
	// Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever
	// you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.
	Metadata *Metadata `json:"metadata,omitempty"`
	// We will call this URL for any payment status changes of payments resulting from this subscription.
	//
	// This webhook will receive **all** events for the subscription's payments. This may include payment failures as
	// well. Be sure to verify the payment's subscription ID and its status.
	WebhookURL *string `json:"webhookUrl,omitempty"`
	CustomerID *string `json:"customerId,omitempty"`
	MandateID  *string `json:"mandateId,omitempty"`
	// The entity's date and time of creation, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	CreatedAt *string `json:"createdAt,omitempty"`
	// The subscription's date and time of cancellation, in ISO 8601 format. This parameter is omitted if the
	// subscription is not canceled (yet).
	CanceledAt *string `json:"canceledAt,omitempty"`
	// An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.
	Links *SubscriptionResponseLinks `json:"_links,omitempty"`
}

func (*SubscriptionResponse) GetAmount 

func (s *SubscriptionResponse) GetAmount() *Amount

func (*SubscriptionResponse) GetApplicationFee 

func (s *SubscriptionResponse) GetApplicationFee() *SubscriptionResponseApplicationFee

func (*SubscriptionResponse) GetCanceledAt 

func (s *SubscriptionResponse) GetCanceledAt() *string

func (*SubscriptionResponse) GetCreatedAt 

func (s *SubscriptionResponse) GetCreatedAt() *string

func (*SubscriptionResponse) GetCustomerID 

func (s *SubscriptionResponse) GetCustomerID() *string

func (*SubscriptionResponse) GetDescription 

func (s *SubscriptionResponse) GetDescription() *string

func (*SubscriptionResponse) GetID 

func (s *SubscriptionResponse) GetID() *string

func (*SubscriptionResponse) GetInterval 

func (s *SubscriptionResponse) GetInterval() *string
func (s *SubscriptionResponse) GetLinks() *SubscriptionResponseLinks

func (*SubscriptionResponse) GetMandateID 

func (s *SubscriptionResponse) GetMandateID() *string

func (*SubscriptionResponse) GetMetadata 

func (s *SubscriptionResponse) GetMetadata() *Metadata

func (*SubscriptionResponse) GetMethod 

func (s *SubscriptionResponse) GetMethod() *SubscriptionMethodResponse

func (*SubscriptionResponse) GetMode 

func (s *SubscriptionResponse) GetMode() *Mode

func (*SubscriptionResponse) GetNextPaymentDate 

func (s *SubscriptionResponse) GetNextPaymentDate() *string

func (*SubscriptionResponse) GetResource 

func (s *SubscriptionResponse) GetResource() *string

func (*SubscriptionResponse) GetStartDate 

func (s *SubscriptionResponse) GetStartDate() *string

func (*SubscriptionResponse) GetStatus 

func (s *SubscriptionResponse) GetStatus() *SubscriptionStatus

func (*SubscriptionResponse) GetTimes 

func (s *SubscriptionResponse) GetTimes() *int64

func (*SubscriptionResponse) GetTimesRemaining 

func (s *SubscriptionResponse) GetTimesRemaining() *int64

func (*SubscriptionResponse) GetWebhookURL 

func (s *SubscriptionResponse) GetWebhookURL() *string

type SubscriptionResponseApplicationFee 

type SubscriptionResponseApplicationFee struct {
	// In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field.
	Amount      Amount `json:"amount"`
	Description string `json:"description"`
}

SubscriptionResponseApplicationFee - With Mollie Connect you can charge fees on payments that your app is processing on behalf of other Mollie merchants.

Setting an application fee on the subscription will ensure this fee is charged on each individual payment.

Refer to the `applicationFee` parameter on the [Get payment endpoint](get-payment) documentation for more information.

func (*SubscriptionResponseApplicationFee) GetAmount 

func (s *SubscriptionResponseApplicationFee) GetAmount() Amount

func (*SubscriptionResponseApplicationFee) GetDescription 

func (s *SubscriptionResponseApplicationFee) GetDescription() string
type SubscriptionResponseLinks struct {
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Self URLObj `json:"self"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Customer *URLNullable `json:"customer"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Mandate *URLNullable `json:"mandate,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Profile *URLNullable `json:"profile"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Payments *URLNullable `json:"payments,omitempty"`
	// In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.
	Documentation URLObj `json:"documentation"`
}

SubscriptionResponseLinks - An object with several relevant URLs. Every URL object will contain an `href` and a `type` field.

func (*SubscriptionResponseLinks) GetCustomer 

func (s *SubscriptionResponseLinks) GetCustomer() *URLNullable

func (*SubscriptionResponseLinks) GetDocumentation 

func (s *SubscriptionResponseLinks) GetDocumentation() URLObj

func (*SubscriptionResponseLinks) GetMandate 

func (s *SubscriptionResponseLinks) GetMandate() *URLNullable

func (*SubscriptionResponseLinks) GetPayments 

func (s *SubscriptionResponseLinks) GetPayments() *URLNullable

func (*SubscriptionResponseLinks) GetProfile 

func (s *SubscriptionResponseLinks) GetProfile() *URLNullable

func (*SubscriptionResponseLinks) GetSelf 

func (s *SubscriptionResponseLinks) GetSelf() URLObj

type SubscriptionStatus 

type SubscriptionStatus string

SubscriptionStatus - The subscription's current status is directly related to the status of the underlying customer or mandate that is enabling the subscription. 

const (
	SubscriptionStatusPending   SubscriptionStatus = "pending"
	SubscriptionStatusActive    SubscriptionStatus = "active"
	SubscriptionStatusCanceled  SubscriptionStatus = "canceled"
	SubscriptionStatusSuspended SubscriptionStatus = "suspended"
	SubscriptionStatusCompleted SubscriptionStatus = "completed"
)

func (SubscriptionStatus) ToPointer 

func (e SubscriptionStatus) ToPointer() *SubscriptionStatus

type TerminalBrand 

type TerminalBrand string

TerminalBrand - The brand of the terminal. 

const (
	TerminalBrandPax TerminalBrand = "PAX"
	TerminalBrandTap TerminalBrand = "Tap"
)

func (TerminalBrand) ToPointer 

func (e TerminalBrand) ToPointer() *TerminalBrand

type TerminalModel 

type TerminalModel string

TerminalModel - The model of the terminal. For example for a PAX A920, this field's value will be `A920`. 

const (
	TerminalModelA35     TerminalModel = "A35"
	TerminalModelA77     TerminalModel = "A77"
	TerminalModelA920    TerminalModel = "A920"
	TerminalModelA920Pro TerminalModel = "A920Pro"
	TerminalModelIm30    TerminalModel = "IM30"
	TerminalModelTap     TerminalModel = "Tap"
)

func (TerminalModel) ToPointer 

func (e TerminalModel) ToPointer() *TerminalModel

type TerminalStatus 

type TerminalStatus string

TerminalStatus - The status of the terminal. 

const (
	TerminalStatusPending  TerminalStatus = "pending"
	TerminalStatusActive   TerminalStatus = "active"
	TerminalStatusInactive TerminalStatus = "inactive"
)

func (TerminalStatus) ToPointer 

func (e TerminalStatus) ToPointer() *TerminalStatus

type Topups 

type Topups struct {
	Pending              *SubGroup `json:"pending,omitempty"`
	MovedToAvailable     *SubGroup `json:"movedToAvailable,omitempty"`
	ImmediatelyAvailable *SubGroup `json:"immediatelyAvailable,omitempty"`
}

Topups - Only available on `transaction-categories` grouping.

func (*Topups) GetImmediatelyAvailable 

func (t *Topups) GetImmediatelyAvailable() *SubGroup

func (*Topups) GetMovedToAvailable 

func (t *Topups) GetMovedToAvailable() *SubGroup

func (*Topups) GetPending 

func (t *Topups) GetPending() *SubGroup

type Totals 

type Totals struct {
	// The pending balance. Only available if grouping is `status-balances`.
	PendingBalance *PendingBalance `json:"pendingBalance,omitempty"`
	// The available balance. Only available if grouping is `status-balances`.
	AvailableBalance *AvailableBalance `json:"availableBalance,omitempty"`
	// Only available on `transaction-categories` grouping.
	Open *Open `json:"open,omitempty"`
	// Only available on `transaction-categories` grouping.
	Close *Close `json:"close,omitempty"`
	// Only available on `transaction-categories` grouping.
	Payments *Payments `json:"payments,omitempty"`
	// Only available on `transaction-categories` grouping.
	Refunds *Refunds `json:"refunds,omitempty"`
	// Only available on `transaction-categories` grouping.
	Chargebacks *Chargebacks `json:"chargebacks,omitempty"`
	// Only available on `transaction-categories` grouping.
	Capital *Capital `json:"capital,omitempty"`
	// Only available on `transaction-categories` grouping.
	Transfers *Transfers `json:"transfers,omitempty"`
	// Only available on `transaction-categories` grouping.
	FeePrepayments *FeePrepayments `json:"fee-prepayments,omitempty"`
	// Only available on `transaction-categories` grouping.
	Corrections *Corrections `json:"corrections,omitempty"`
	// Only available on `transaction-categories` grouping.
	Topups *Topups `json:"topups,omitempty"`
}

Totals are grouped according to the chosen grouping rule. The example response should give a good idea of what a typical grouping looks like.

If grouping `status-balances` is chosen, the main grouping is as follows:

* `pendingBalance` containing an `open`, `pending`, `movedToAvailable`, and `close` sub-group * `availableBalance` containing an `open`, `movedFromPending`, `immediatelyAvailable`, and `close` sub-group

If grouping `transaction-categories` is chosen, the main grouping is as follows:

* `open` and `close` groups, each containing a `pending` and `available` sub-group * Transaction type groups such as `payments`, `refunds`, `chargebacks`, `capital`, `transfers`, `fee-prepayments`, `corrections`, `topups` each containing a `pending`, `movedToAvailable`, and `immediatelyAvailable` sub-group

Each sub-group typically has:

* An `amount` object containing the group's total amount * A `count` integer if relevant (for example, counting the number of refunds) * A `subtotals` array containing more sub-group objects if applicable

func (*Totals) GetAvailableBalance 

func (t *Totals) GetAvailableBalance() *AvailableBalance

func (*Totals) GetCapital 

func (t *Totals) GetCapital() *Capital

func (*Totals) GetChargebacks 

func (t *Totals) GetChargebacks() *Chargebacks

func (*Totals) GetClose 

func (t *Totals) GetClose() *Close

func (*Totals) GetCorrections 

func (t *Totals) GetCorrections() *Corrections

func (*Totals) GetFeePrepayments 

func (t *Totals) GetFeePrepayments() *FeePrepayments

func (*Totals) GetOpen 

func (t *Totals) GetOpen() *Open

func (*Totals) GetPayments 

func (t *Totals) GetPayments() *Payments

func (*Totals) GetPendingBalance 

func (t *Totals) GetPendingBalance() *PendingBalance

func (*Totals) GetRefunds 

func (t *Totals) GetRefunds() *Refunds

func (*Totals) GetTopups 

func (t *Totals) GetTopups() *Topups

func (*Totals) GetTransfers 

func (t *Totals) GetTransfers() *Transfers

type TransferDestination 

type TransferDestination struct {
	// The default destination of automatic scheduled transfers. Currently only `bank-account` is supported.
	//
	// * `bank-account` — Transfer the balance amount to an external bank account
	Type *BalanceTransferDestinationType `json:"type,omitempty"`
	// The configured bank account number of the beneficiary the balance amount is to be transferred to.
	BankAccount *string `json:"bankAccount,omitempty"`
	// The full name of the beneficiary the balance amount is to be transferred to.
	BeneficiaryName *string `json:"beneficiaryName,omitempty"`
}

TransferDestination - The destination where the available amount will be automatically transferred to according to the configured transfer frequency.

func (*TransferDestination) GetBankAccount 

func (t *TransferDestination) GetBankAccount() *string

func (*TransferDestination) GetBeneficiaryName 

func (t *TransferDestination) GetBeneficiaryName() *string

func (*TransferDestination) GetType 

func (t *TransferDestination) GetType() *BalanceTransferDestinationType

type Transfers 

type Transfers struct {
	Pending              *SubGroup `json:"pending,omitempty"`
	MovedToAvailable     *SubGroup `json:"movedToAvailable,omitempty"`
	ImmediatelyAvailable *SubGroup `json:"immediatelyAvailable,omitempty"`
}

Transfers - Only available on `transaction-categories` grouping.

func (*Transfers) GetImmediatelyAvailable 

func (t *Transfers) GetImmediatelyAvailable() *SubGroup

func (*Transfers) GetMovedToAvailable 

func (t *Transfers) GetMovedToAvailable() *SubGroup

func (*Transfers) GetPending 

func (t *Transfers) GetPending() *SubGroup

type URLNullable 

type URLNullable struct {
	// The actual URL string.
	Href *string `json:"href,omitempty"`
	// The content type of the page or endpoint the URL points to.
	Type *string `json:"type,omitempty"`
}

URLNullable - In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.

func (*URLNullable) GetHref 

func (u *URLNullable) GetHref() *string

func (*URLNullable) GetType 

func (u *URLNullable) GetType() *string

type URLObj 

type URLObj struct {
	// The actual URL string.
	Href string `json:"href"`
	// The content type of the page or endpoint the URL points to.
	Type string `json:"type"`
}

URLObj - In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field.

func (*URLObj) GetHref 

func (u *URLObj) GetHref() string

func (*URLObj) GetType 

func (u *URLObj) GetType() string

func (URLObj) MarshalJSON 

func (u URLObj) MarshalJSON() ([]byte, error)

func (*URLObj) UnmarshalJSON 

func (u *URLObj) UnmarshalJSON(data []byte) error

type UnauthorizedDirectDebit 

type UnauthorizedDirectDebit struct {
	PaymentID          *string `json:"paymentId,omitempty"`
	PaymentDescription *string `json:"paymentDescription,omitempty"`
}

func (*UnauthorizedDirectDebit) GetPaymentDescription 

func (u *UnauthorizedDirectDebit) GetPaymentDescription() *string

func (*UnauthorizedDirectDebit) GetPaymentID 

func (u *UnauthorizedDirectDebit) GetPaymentID() *string

type UpdateValuesSalesInvoice 

type UpdateValuesSalesInvoice struct {
	// Most API credentials are specifically created for either live mode or test mode. For organization-level credentials
	// such as OAuth access tokens, you can enable test mode by setting `testmode` to `true`.
	//
	// Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.
	Testmode *bool `json:"testmode,omitempty"`
	// The status for the invoice to end up in.
	//
	// A `draft` invoice is not paid or not sent and can be updated after creation. Setting it to `issued` sends it to
	// the recipient so they may then pay through our payment system. To skip our payment process, set this to `paid` to
	// mark it as paid. It can then subsequently be sent as well, same as with `issued`.
	//
	// A status value that cannot be set but can be returned is `canceled`, for invoices which were
	// issued, but then canceled. Currently this can only be done for invoices created in the dashboard.
	//
	// Dependent parameters:
	//   - `paymentDetails` is required if invoice should be set directly to `paid`
	//   - `customerId` and `mandateId` are required if a recurring payment should be used to set the invoice to `paid`
	//   - `emailDetails` optional for `issued` and `paid` to send the invoice by email
	Status *SalesInvoiceStatus `json:"status,omitempty"`
	// A free-form memo you can set on the invoice, and will be shown on the invoice PDF.
	Memo *string `json:"memo,omitempty"`
	// The payment term to be set on the invoice.
	PaymentTerm    *SalesInvoicePaymentTerm    `json:"paymentTerm,omitempty"`
	PaymentDetails *SalesInvoicePaymentDetails `json:"paymentDetails,omitempty"`
	EmailDetails   *SalesInvoiceEmailDetails   `json:"emailDetails,omitempty"`
	// An identifier tied to the recipient data. This should be a unique value based on data your system contains,
	// so that both you and us know who we're referring to. It is a value you provide to us so that recipient management
	// is not required to send a first invoice to a recipient.
	RecipientIdentifier *string                `json:"recipientIdentifier,omitempty"`
	Recipient           *SalesInvoiceRecipient `json:"recipient,omitempty"`
	// Provide the line items for the invoice. Each line contains details such as a description of the item
	// ordered and its price.
	//
	// All lines must have the same currency as the invoice.
	Lines    []SalesInvoiceLineItem `json:"lines,omitempty"`
	Discount *SalesInvoiceDiscount  `json:"discount,omitempty"`
	// This indicates whether the invoice is an e-invoice. The default value is `false` and can't be changed
	// after the invoice has been issued.
	//
	// When `emailDetails` is provided, an additional email is sent to the recipient.
	IsEInvoice *bool `json:"isEInvoice,omitempty"`
}

func (*UpdateValuesSalesInvoice) GetDiscount 

func (u *UpdateValuesSalesInvoice) GetDiscount() *SalesInvoiceDiscount

func (*UpdateValuesSalesInvoice) GetEmailDetails 

func (u *UpdateValuesSalesInvoice) GetEmailDetails() *SalesInvoiceEmailDetails

func (*UpdateValuesSalesInvoice) GetIsEInvoice added in v0.3.0 

func (u *UpdateValuesSalesInvoice) GetIsEInvoice() *bool

func (*UpdateValuesSalesInvoice) GetLines 

func (u *UpdateValuesSalesInvoice) GetLines() []SalesInvoiceLineItem

func (*UpdateValuesSalesInvoice) GetMemo 

func (u *UpdateValuesSalesInvoice) GetMemo() *string

func (*UpdateValuesSalesInvoice) GetPaymentDetails 

func (u *UpdateValuesSalesInvoice) GetPaymentDetails() *SalesInvoicePaymentDetails

func (*UpdateValuesSalesInvoice) GetPaymentTerm 

func (u *UpdateValuesSalesInvoice) GetPaymentTerm() *SalesInvoicePaymentTerm

func (*UpdateValuesSalesInvoice) GetRecipient 

func (u *UpdateValuesSalesInvoice) GetRecipient() *SalesInvoiceRecipient

func (*UpdateValuesSalesInvoice) GetRecipientIdentifier 

func (u *UpdateValuesSalesInvoice) GetRecipientIdentifier() *string

func (*UpdateValuesSalesInvoice) GetStatus 

func (u *UpdateValuesSalesInvoice) GetStatus() *SalesInvoiceStatus

func (*UpdateValuesSalesInvoice) GetTestmode 

func (u *UpdateValuesSalesInvoice) GetTestmode() *bool

type WebhookEventTypes 

type WebhookEventTypes string

WebhookEventTypes - The event's type 

const (
	WebhookEventTypesPaymentLinkPaid           WebhookEventTypes = "payment-link.paid"
	WebhookEventTypesBalanceTransactionCreated WebhookEventTypes = "balance-transaction.created"
	WebhookEventTypesSalesInvoiceCreated       WebhookEventTypes = "sales-invoice.created"
	WebhookEventTypesSalesInvoiceIssued        WebhookEventTypes = "sales-invoice.issued"
	WebhookEventTypesSalesInvoiceCanceled      WebhookEventTypes = "sales-invoice.canceled"
	WebhookEventTypesSalesInvoicePaid          WebhookEventTypes = "sales-invoice.paid"
	WebhookEventTypesWildcard                  WebhookEventTypes = "*"
)

func (WebhookEventTypes) ToPointer 

func (e WebhookEventTypes) ToPointer() *WebhookEventTypes

func (*WebhookEventTypes) UnmarshalJSON 

func (e *WebhookEventTypes) UnmarshalJSON(data []byte) error

type WebhookStatus 

type WebhookStatus string

WebhookStatus - The subscription's current status. 

const (
	WebhookStatusEnabled  WebhookStatus = "enabled"
	WebhookStatusBlocked  WebhookStatus = "blocked"
	WebhookStatusDisabled WebhookStatus = "disabled"
	WebhookStatusDeleted  WebhookStatus = "deleted"
)

func (WebhookStatus) ToPointer 

func (e WebhookStatus) ToPointer() *WebhookStatus

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.