balancecontrol

package
v8.0.0 Latest Latest
Warning

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

 Go to latest Published: Nov 7, 2023 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Amount 

type Amount struct {
	// The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes).
	Currency string `json:"currency"`
	// The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes).
	Value int64 `json:"value"`
}

Amount struct for Amount

func NewAmount 

func NewAmount(currency string, value int64) *Amount

NewAmount instantiates a new Amount object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewAmountWithDefaults 

func NewAmountWithDefaults() *Amount

NewAmountWithDefaults instantiates a new Amount object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*Amount) GetCurrency 

func (o *Amount) GetCurrency() string

GetCurrency returns the Currency field value

func (*Amount) GetCurrencyOk 

func (o *Amount) GetCurrencyOk() (*string, bool)

GetCurrencyOk returns a tuple with the Currency field value and a boolean to check if the value has been set.

func (*Amount) GetValue 

func (o *Amount) GetValue() int64

GetValue returns the Value field value

func (*Amount) GetValueOk 

func (o *Amount) GetValueOk() (*int64, bool)

GetValueOk returns a tuple with the Value field value and a boolean to check if the value has been set.

func (Amount) MarshalJSON 

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

func (*Amount) SetCurrency 

func (o *Amount) SetCurrency(v string)

SetCurrency sets field value

func (*Amount) SetValue 

func (o *Amount) SetValue(v int64)

SetValue sets field value

func (Amount) ToMap 

func (o Amount) ToMap() (map[string]interface{}, error)

type BalanceTransferRequest 

type BalanceTransferRequest struct {
	Amount Amount `json:"amount"`
	// A human-readable description for the transfer. You can use alphanumeric characters and hyphens. We recommend sending a maximum of 140 characters, otherwise the description may be truncated.
	Description *string `json:"description,omitempty"`
	// The unique identifier of the source merchant account from which funds are deducted.
	FromMerchant string `json:"fromMerchant"`
	// A reference for the balance transfer. If you don't provide this in the request, Adyen generates a unique reference. Maximum length: 80 characters.
	Reference *string `json:"reference,omitempty"`
	// The unique identifier of the destination merchant account from which funds are transferred.
	ToMerchant string `json:"toMerchant"`
	// The type of balance transfer. Possible values: **tax**, **fee**, **terminalSale**, **credit**, **debit**, and **adjustment**.
	Type string `json:"type"`
}

BalanceTransferRequest struct for BalanceTransferRequest

func NewBalanceTransferRequest 

func NewBalanceTransferRequest(amount Amount, fromMerchant string, toMerchant string, type_ string) *BalanceTransferRequest

NewBalanceTransferRequest instantiates a new BalanceTransferRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewBalanceTransferRequestWithDefaults 

func NewBalanceTransferRequestWithDefaults() *BalanceTransferRequest

NewBalanceTransferRequestWithDefaults instantiates a new BalanceTransferRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*BalanceTransferRequest) GetAmount 

func (o *BalanceTransferRequest) GetAmount() Amount

GetAmount returns the Amount field value

func (*BalanceTransferRequest) GetAmountOk 

func (o *BalanceTransferRequest) GetAmountOk() (*Amount, bool)

GetAmountOk returns a tuple with the Amount field value and a boolean to check if the value has been set.

func (*BalanceTransferRequest) GetDescription 

func (o *BalanceTransferRequest) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise.

func (*BalanceTransferRequest) GetDescriptionOk 

func (o *BalanceTransferRequest) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BalanceTransferRequest) GetFromMerchant 

func (o *BalanceTransferRequest) GetFromMerchant() string

GetFromMerchant returns the FromMerchant field value

func (*BalanceTransferRequest) GetFromMerchantOk 

func (o *BalanceTransferRequest) GetFromMerchantOk() (*string, bool)

GetFromMerchantOk returns a tuple with the FromMerchant field value and a boolean to check if the value has been set.

func (*BalanceTransferRequest) GetReference 

func (o *BalanceTransferRequest) GetReference() string

GetReference returns the Reference field value if set, zero value otherwise.

func (*BalanceTransferRequest) GetReferenceOk 

func (o *BalanceTransferRequest) GetReferenceOk() (*string, bool)

GetReferenceOk returns a tuple with the Reference field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BalanceTransferRequest) GetToMerchant 

func (o *BalanceTransferRequest) GetToMerchant() string

GetToMerchant returns the ToMerchant field value

func (*BalanceTransferRequest) GetToMerchantOk 

func (o *BalanceTransferRequest) GetToMerchantOk() (*string, bool)

GetToMerchantOk returns a tuple with the ToMerchant field value and a boolean to check if the value has been set.

func (*BalanceTransferRequest) GetType 

func (o *BalanceTransferRequest) GetType() string

GetType returns the Type field value

func (*BalanceTransferRequest) GetTypeOk 

func (o *BalanceTransferRequest) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field value and a boolean to check if the value has been set.

func (*BalanceTransferRequest) HasDescription 

func (o *BalanceTransferRequest) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*BalanceTransferRequest) HasReference 

func (o *BalanceTransferRequest) HasReference() bool

HasReference returns a boolean if a field has been set.

func (BalanceTransferRequest) MarshalJSON 

func (o BalanceTransferRequest) MarshalJSON() ([]byte, error)

func (*BalanceTransferRequest) SetAmount 

func (o *BalanceTransferRequest) SetAmount(v Amount)

SetAmount sets field value

func (*BalanceTransferRequest) SetDescription 

func (o *BalanceTransferRequest) SetDescription(v string)

SetDescription gets a reference to the given string and assigns it to the Description field.

func (*BalanceTransferRequest) SetFromMerchant 

func (o *BalanceTransferRequest) SetFromMerchant(v string)

SetFromMerchant sets field value

func (*BalanceTransferRequest) SetReference 

func (o *BalanceTransferRequest) SetReference(v string)

SetReference gets a reference to the given string and assigns it to the Reference field.

func (*BalanceTransferRequest) SetToMerchant 

func (o *BalanceTransferRequest) SetToMerchant(v string)

SetToMerchant sets field value

func (*BalanceTransferRequest) SetType 

func (o *BalanceTransferRequest) SetType(v string)

SetType sets field value

func (BalanceTransferRequest) ToMap 

func (o BalanceTransferRequest) ToMap() (map[string]interface{}, error)

type BalanceTransferResponse 

type BalanceTransferResponse struct {
	Amount Amount `json:"amount"`
	// The date when the balance transfer was requested.
	CreatedAt time.Time `json:"createdAt"`
	// A human-readable description for the transfer. You can use alphanumeric characters and hyphens. We recommend sending a maximum of 140 characters, otherwise the description may be truncated.
	Description *string `json:"description,omitempty"`
	// The unique identifier of the source merchant account from which funds are deducted.
	FromMerchant string `json:"fromMerchant"`
	// Adyen's 16-character string reference associated with the balance transfer.
	PspReference string `json:"pspReference"`
	// A reference for the balance transfer. If you don't provide this in the request, Adyen generates a unique reference. Maximum length: 80 characters.
	Reference *string `json:"reference,omitempty"`
	// The status of the balance transfer. Possible values: **transferred**, **failed**, **error**, and **notEnoughBalance**.
	Status string `json:"status"`
	// The unique identifier of the destination merchant account from which funds are transferred.
	ToMerchant string `json:"toMerchant"`
	// The type of balance transfer. Possible values: **tax**, **fee**, **terminalSale**, **credit**, **debit**, and **adjustment**.
	Type string `json:"type"`
}

BalanceTransferResponse struct for BalanceTransferResponse

func NewBalanceTransferResponse 

func NewBalanceTransferResponse(amount Amount, createdAt time.Time, fromMerchant string, pspReference string, status string, toMerchant string, type_ string) *BalanceTransferResponse

NewBalanceTransferResponse instantiates a new BalanceTransferResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewBalanceTransferResponseWithDefaults 

func NewBalanceTransferResponseWithDefaults() *BalanceTransferResponse

NewBalanceTransferResponseWithDefaults instantiates a new BalanceTransferResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*BalanceTransferResponse) GetAmount 

func (o *BalanceTransferResponse) GetAmount() Amount

GetAmount returns the Amount field value

func (*BalanceTransferResponse) GetAmountOk 

func (o *BalanceTransferResponse) GetAmountOk() (*Amount, bool)

GetAmountOk returns a tuple with the Amount field value and a boolean to check if the value has been set.

func (*BalanceTransferResponse) GetCreatedAt 

func (o *BalanceTransferResponse) GetCreatedAt() time.Time

GetCreatedAt returns the CreatedAt field value

func (*BalanceTransferResponse) GetCreatedAtOk 

func (o *BalanceTransferResponse) GetCreatedAtOk() (*time.Time, bool)

GetCreatedAtOk returns a tuple with the CreatedAt field value and a boolean to check if the value has been set.

func (*BalanceTransferResponse) GetDescription 

func (o *BalanceTransferResponse) GetDescription() string

GetDescription returns the Description field value if set, zero value otherwise.

func (*BalanceTransferResponse) GetDescriptionOk 

func (o *BalanceTransferResponse) GetDescriptionOk() (*string, bool)

GetDescriptionOk returns a tuple with the Description field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BalanceTransferResponse) GetFromMerchant 

func (o *BalanceTransferResponse) GetFromMerchant() string

GetFromMerchant returns the FromMerchant field value

func (*BalanceTransferResponse) GetFromMerchantOk 

func (o *BalanceTransferResponse) GetFromMerchantOk() (*string, bool)

GetFromMerchantOk returns a tuple with the FromMerchant field value and a boolean to check if the value has been set.

func (*BalanceTransferResponse) GetPspReference 

func (o *BalanceTransferResponse) GetPspReference() string

GetPspReference returns the PspReference field value

func (*BalanceTransferResponse) GetPspReferenceOk 

func (o *BalanceTransferResponse) GetPspReferenceOk() (*string, bool)

GetPspReferenceOk returns a tuple with the PspReference field value and a boolean to check if the value has been set.

func (*BalanceTransferResponse) GetReference 

func (o *BalanceTransferResponse) GetReference() string

GetReference returns the Reference field value if set, zero value otherwise.

func (*BalanceTransferResponse) GetReferenceOk 

func (o *BalanceTransferResponse) GetReferenceOk() (*string, bool)

GetReferenceOk returns a tuple with the Reference field value if set, nil otherwise and a boolean to check if the value has been set.

func (*BalanceTransferResponse) GetStatus 

func (o *BalanceTransferResponse) GetStatus() string

GetStatus returns the Status field value

func (*BalanceTransferResponse) GetStatusOk 

func (o *BalanceTransferResponse) GetStatusOk() (*string, bool)

GetStatusOk returns a tuple with the Status field value and a boolean to check if the value has been set.

func (*BalanceTransferResponse) GetToMerchant 

func (o *BalanceTransferResponse) GetToMerchant() string

GetToMerchant returns the ToMerchant field value

func (*BalanceTransferResponse) GetToMerchantOk 

func (o *BalanceTransferResponse) GetToMerchantOk() (*string, bool)

GetToMerchantOk returns a tuple with the ToMerchant field value and a boolean to check if the value has been set.

func (*BalanceTransferResponse) GetType 

func (o *BalanceTransferResponse) GetType() string

GetType returns the Type field value

func (*BalanceTransferResponse) GetTypeOk 

func (o *BalanceTransferResponse) GetTypeOk() (*string, bool)

GetTypeOk returns a tuple with the Type field value and a boolean to check if the value has been set.

func (*BalanceTransferResponse) HasDescription 

func (o *BalanceTransferResponse) HasDescription() bool

HasDescription returns a boolean if a field has been set.

func (*BalanceTransferResponse) HasReference 

func (o *BalanceTransferResponse) HasReference() bool

HasReference returns a boolean if a field has been set.

func (BalanceTransferResponse) MarshalJSON 

func (o BalanceTransferResponse) MarshalJSON() ([]byte, error)

func (*BalanceTransferResponse) SetAmount 

func (o *BalanceTransferResponse) SetAmount(v Amount)

SetAmount sets field value

func (*BalanceTransferResponse) SetCreatedAt 

func (o *BalanceTransferResponse) SetCreatedAt(v time.Time)

SetCreatedAt sets field value

func (*BalanceTransferResponse) SetDescription 

func (o *BalanceTransferResponse) SetDescription(v string)

SetDescription gets a reference to the given string and assigns it to the Description field.

func (*BalanceTransferResponse) SetFromMerchant 

func (o *BalanceTransferResponse) SetFromMerchant(v string)

SetFromMerchant sets field value

func (*BalanceTransferResponse) SetPspReference 

func (o *BalanceTransferResponse) SetPspReference(v string)

SetPspReference sets field value

func (*BalanceTransferResponse) SetReference 

func (o *BalanceTransferResponse) SetReference(v string)

SetReference gets a reference to the given string and assigns it to the Reference field.

func (*BalanceTransferResponse) SetStatus 

func (o *BalanceTransferResponse) SetStatus(v string)

SetStatus sets field value

func (*BalanceTransferResponse) SetToMerchant 

func (o *BalanceTransferResponse) SetToMerchant(v string)

SetToMerchant sets field value

func (*BalanceTransferResponse) SetType 

func (o *BalanceTransferResponse) SetType(v string)

SetType sets field value

func (BalanceTransferResponse) ToMap 

func (o BalanceTransferResponse) ToMap() (map[string]interface{}, error)

type GeneralApi 

type GeneralApi common.Service

GeneralApi service

func (*GeneralApi) BalanceTransfer 

func (a *GeneralApi) BalanceTransfer(ctx context.Context, r GeneralApiBalanceTransferInput) (BalanceTransferResponse, *http.Response, error)

BalanceTransfer Start a balance transfer

Starts a balance transfer request between merchant accounts. The following conditions must be met before you can successfully transfer balances:

* The source and destination merchant accounts must be under the same company account and legal entity.

* The source merchant account must have sufficient funds.

* The source and destination merchant accounts must have at least one common processing currency.

When sending multiple API requests with the same source and destination merchant accounts, send the requests sequentially and *not* in parallel. Some requests may not be processed if the requests are sent in parallel.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param r GeneralApiBalanceTransferInput - Request parameters, see BalanceTransferInput @return BalanceTransferResponse, *http.Response, error

func (*GeneralApi) BalanceTransferInput 

func (a *GeneralApi) BalanceTransferInput() GeneralApiBalanceTransferInput

Prepare a request for BalanceTransfer

@return GeneralApiBalanceTransferInput

type GeneralApiBalanceTransferInput 

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

All parameters accepted by GeneralApi.BalanceTransfer

func (GeneralApiBalanceTransferInput) BalanceTransferRequest 

func (r GeneralApiBalanceTransferInput) BalanceTransferRequest(balanceTransferRequest BalanceTransferRequest) GeneralApiBalanceTransferInput

type NullableAmount 

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

func NewNullableAmount 

func NewNullableAmount(val *Amount) *NullableAmount

func (NullableAmount) Get 

func (v NullableAmount) Get() *Amount

func (NullableAmount) IsSet 

func (v NullableAmount) IsSet() bool

func (NullableAmount) MarshalJSON 

func (v NullableAmount) MarshalJSON() ([]byte, error)

func (*NullableAmount) Set 

func (v *NullableAmount) Set(val *Amount)

func (*NullableAmount) UnmarshalJSON 

func (v *NullableAmount) UnmarshalJSON(src []byte) error

func (*NullableAmount) Unset 

func (v *NullableAmount) Unset()

type NullableBalanceTransferRequest 

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

func NewNullableBalanceTransferRequest 

func NewNullableBalanceTransferRequest(val *BalanceTransferRequest) *NullableBalanceTransferRequest

func (NullableBalanceTransferRequest) Get 

func (v NullableBalanceTransferRequest) Get() *BalanceTransferRequest

func (NullableBalanceTransferRequest) IsSet 

func (v NullableBalanceTransferRequest) IsSet() bool

func (NullableBalanceTransferRequest) MarshalJSON 

func (v NullableBalanceTransferRequest) MarshalJSON() ([]byte, error)

func (*NullableBalanceTransferRequest) Set 

func (v *NullableBalanceTransferRequest) Set(val *BalanceTransferRequest)

func (*NullableBalanceTransferRequest) UnmarshalJSON 

func (v *NullableBalanceTransferRequest) UnmarshalJSON(src []byte) error

func (*NullableBalanceTransferRequest) Unset 

func (v *NullableBalanceTransferRequest) Unset()

type NullableBalanceTransferResponse 

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

func NewNullableBalanceTransferResponse 

func NewNullableBalanceTransferResponse(val *BalanceTransferResponse) *NullableBalanceTransferResponse

func (NullableBalanceTransferResponse) Get 

func (v NullableBalanceTransferResponse) Get() *BalanceTransferResponse

func (NullableBalanceTransferResponse) IsSet 

func (v NullableBalanceTransferResponse) IsSet() bool

func (NullableBalanceTransferResponse) MarshalJSON 

func (v NullableBalanceTransferResponse) MarshalJSON() ([]byte, error)

func (*NullableBalanceTransferResponse) Set 

func (v *NullableBalanceTransferResponse) Set(val *BalanceTransferResponse)

func (*NullableBalanceTransferResponse) UnmarshalJSON 

func (v *NullableBalanceTransferResponse) UnmarshalJSON(src []byte) error

func (*NullableBalanceTransferResponse) Unset 

func (v *NullableBalanceTransferResponse) Unset()

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.