payouts

package
v0.3.0 Latest Latest
Warning

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

Go to latest
Published: Oct 23, 2025 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type FinancialPayout

type FinancialPayout struct {
	Amount   *float64 `json:"amount,omitempty"`
	Currency *string  `json:"currency,omitempty"`
	// Format: date
	Date            *shared.Date           `json:"date,omitempty"`
	Fee             *float64               `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 ListPayoutsParams

type ListPayoutsParams struct {
	// End date (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format).
	EndDate shared.Date
	Format  *string
	Limit   *int
	Order   *string
	// Start date (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format).
	StartDate shared.Date
}

ListPayoutsParams: query parameters for ListPayouts

func (*ListPayoutsParams) QueryValues

func (p *ListPayoutsParams) QueryValues() url.Values

QueryValues converts ListPayoutsParams into url.Values.

type ListPayoutsV1Params

type ListPayoutsV1Params struct {
	// End date (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format).
	EndDate shared.Date
	Format  *string
	Limit   *int
	Order   *string
	// Start date (in [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) format).
	StartDate shared.Date
}

ListPayoutsV1Params: query parameters for ListPayoutsV1

func (*ListPayoutsV1Params) QueryValues

func (p *ListPayoutsV1Params) QueryValues() url.Values

QueryValues converts ListPayoutsV1Params into url.Values.

type PayoutsService

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

func NewPayoutsService

func NewPayoutsService(c *client.Client) *PayoutsService

func (*PayoutsService) List

func (s *PayoutsService) List(ctx context.Context, merchantCode string, params ListPayoutsV1Params) (*FinancialPayouts, error)

List: List payouts Lists ordered payouts for the merchant profile.

func (*PayoutsService) ListDeprecated

func (s *PayoutsService) ListDeprecated(ctx context.Context, params ListPayoutsParams) (*FinancialPayouts, error)

ListDeprecated: List payouts Lists ordered payouts for the merchant profile. Deprecated: this operation is deprecated

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL