payouts

package

v0.1.0 Latest Latest Go to latest Published: Aug 9, 2023 License: BSD-3-Clause Imports: 2 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package payouts provides access to Circle's Payouts APIs.

The Payouts API allows you to issue payouts to your customers, vendors, or suppliers in a variety of ways:

Payouts are funded with your USDC denominated Circle Account, which can receive deposits from both traditional and blockchain payment rails.

This section is empty.

This section is empty.

This section is empty.

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

API The Circle Payouts API allows you to issue payouts to your customers, vendors, or suppliers in a variety of ways:

Payouts are funded with your USDC denominated Circle Account, which can receive deposits from both traditional and blockchain payment rails.

func (mod *API) CreatePayout(c circlesdk.CreatePayoutRequest, opts ...circlesdk.CallOption) (*circlesdk.Payout, error)

func (mod *API) GetPayout(id string, opts ...circlesdk.CallOption) (*circlesdk.Payout, error)

func (mod *API) ListPayouts(l circlesdk.ListPayoutsRequest, opts ...circlesdk.CallOption) ([]*circlesdk.Payout, error)

ListPayouts returns a list of payouts based on the passed request and options. https://developers.circle.com/reference/payouts-payouts-get

func (mod *API) ListReturns(opts ...circlesdk.CallOption) ([]*circlesdk.PayoutReturn, error)

ListReturns returns a list of returns based on the passed options. https://developers.circle.com/reference/payouts-returns-get