yoopayout

Documentation

Overview

Package yoopayout describes all the necessary entities for working with YooMoney Payouts.

Package yoopayout describes all the necessary entities for working with YooMoney Payouts.

Index

• type Payout
• type PayoutBalance
• type PayoutCancellationDetails
• type PayoutDeal
• type PayoutDestination
• type PayoutMethodType
• type PayoutReceipt
• type PayoutSelfEmployed
• type PayoutStatus

Types

type Payout

type Payout struct {
	Id                  string                     `json:"id,omitempty"`
	Amount              *yoocommon.Amount          `json:"amount,omitempty"`
	Status              PayoutStatus               `json:"status,omitempty"`
	PayoutDestination   *PayoutDestination         `json:"payout_destination,omitempty"`
	Description         string                     `json:"description,omitempty"`
	CreatedAt           time.Time                  `json:"created_at,omitempty"`
	Deal                *PayoutDeal                `json:"deal,omitempty"`
	SelfEmployed        *PayoutSelfEmployed        `json:"self_employed,omitempty"`
	Receipt             *PayoutReceipt             `json:"receipt,omitempty"`
	CancellationDetails *PayoutCancellationDetails `json:"cancellation_details,omitempty"`
	Metadata            interface{}                `json:"metadata,omitempty"`
	Test                bool                       `json:"test,omitempty"`
}

type PayoutBalance

type PayoutBalance struct {
	// Amount in the selected currency.
	// Expressed as a string and written with a period, for example 10.00.
	// The number of characters after the dot depends on the selected currency.
	Value string `json:"value,omitempty"`

	// Three-letter currency code in ISO-4217 format.
	// Example: RUB. Must match the subaccount currency (recipient.gateway_id) if you separate payment flows,
	// and the account currency (shopId in your account) if you don't.
	Currency string `json:"currency,omitempty"`
}

The balance of your gateway.

type PayoutCancellationDetails

type PayoutCancellationDetails struct {
	Party  string `json:"party,omitempty"`
	Reason string `json:"reason,omitempty"`
}

type PayoutDeal

type PayoutDeal struct {
	Id string `json:"id,omitempty"`
}

type PayoutDestination

type PayoutDestination struct {
	Type PayoutMethodType `json:"type"`
}

type PayoutMethodType

type PayoutMethodType string

const (
	// Payments to bank cards.
	PayoutTypeBankCard PayoutMethodType = "bank_card"
	// Payments to YooMoney wallets.
	PaymentTypeYooMoney PayoutMethodType = "yoo_money"
	// Payments via SBP.
	PayoutTypeSBP PayoutMethodType = "sbp"
)

type PayoutReceipt

type PayoutReceipt struct {
	ServiceName  string            `json:"service_name,omitempty"`
	NpdReceiptId string            `json:"npd_receipt_id,omitempty"`
	URL          string            `json:"url,omitempty"`
	Amount       *yoocommon.Amount `json:"amount,omitempty"`
}

type PayoutSelfEmployed

type PayoutSelfEmployed struct {
	Id string `json:"id,omitempty"`
}

type PayoutStatus

type PayoutStatus string

const (
	PayoutStatusPending   PayoutStatus = "pending"
	PayoutStatusSucceeded PayoutStatus = "succeeded"
	PayoutStatusCanceled  PayoutStatus = "canceled"
)