Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶ added in v0.13.0
type Client struct {
// contains filtered or unexported fields
}
func (*Client) List ¶ added in v0.13.0
func (c *Client) List(ctx context.Context, merchantCode string, params ListParams) (*FinancialPayouts, error)
Lists ordered payouts for the merchant profile.
func (*Client) ListDeprecated ¶ added in v0.13.0
func (c *Client) ListDeprecated(ctx context.Context, params ListDeprecatedParams) (*FinancialPayouts, error)
Lists ordered payouts for the merchant profile. Deprecated: this operation is deprecated
type FinancialPayout ¶
type FinancialPayout struct {
Amount *float32 `json:"amount,omitempty"`
Currency *string `json:"currency,omitempty"`
// Format: date
Date *datetime.Date `json:"date,omitempty"`
Fee *float32 `json:"fee,omitempty"`
ID *int `json:"id,omitempty"`
Reference *string `json:"reference,omitempty"`
Status *FinancialPayoutStatus `json:"status,omitempty"`
TransactionCode *string `json:"transaction_code,omitempty"`
Type *FinancialPayoutType `json:"type,omitempty"`
}
FinancialPayout is a schema definition.
type FinancialPayoutStatus ¶
type FinancialPayoutStatus string
FinancialPayoutStatus is a schema definition.
const ( FinancialPayoutStatusFailed FinancialPayoutStatus = "FAILED" FinancialPayoutStatusSuccessful FinancialPayoutStatus = "SUCCESSFUL" )
type FinancialPayoutType ¶
type FinancialPayoutType string
FinancialPayoutType is a schema definition.
const ( FinancialPayoutTypeBalanceDeduction FinancialPayoutType = "BALANCE_DEDUCTION" FinancialPayoutTypeChargeBackDeduction FinancialPayoutType = "CHARGE_BACK_DEDUCTION" FinancialPayoutTypeDdReturnDeduction FinancialPayoutType = "DD_RETURN_DEDUCTION" FinancialPayoutTypePayout FinancialPayoutType = "PAYOUT" FinancialPayoutTypeRefundDeduction FinancialPayoutType = "REFUND_DEDUCTION" )
type FinancialPayouts ¶
type FinancialPayouts []FinancialPayout
FinancialPayouts is a schema definition.
type ListDeprecatedParams ¶ added in v0.12.0
type ListDeprecatedParams struct {
// End date (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format).
EndDate datetime.Date
Format *string
Limit *int
Order *string
// Start date (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format).
StartDate datetime.Date
}
ListDeprecatedParams are query parameters for ListPayouts.
func (*ListDeprecatedParams) QueryValues ¶ added in v0.12.0
func (p *ListDeprecatedParams) QueryValues() url.Values
QueryValues converts ListDeprecatedParams into url.Values.
type ListParams ¶ added in v0.12.0
type ListParams struct {
// End date (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format).
EndDate datetime.Date
Format *string
Limit *int
Order *string
// Start date (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format).
StartDate datetime.Date
}
ListParams are query parameters for ListPayoutsV1.
func (*ListParams) QueryValues ¶ added in v0.12.0
func (p *ListParams) QueryValues() url.Values
QueryValues converts ListParams into url.Values.
Source Files
Click to show internal directories.
Click to hide internal directories.