Documentation ¶
Overview ¶
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:
- Bank wires
- On-chain USDC transfers
- ACH (coming soon)
Payouts are funded with your USDC denominated Circle Account, which can receive deposits from both traditional and blockchain payment rails.
Index ¶
- type API
- 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)
- func (mod *API) ListReturns(opts ...circlesdk.CallOption) ([]*circlesdk.PayoutReturn, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type API ¶
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:
- Bank wires
- On-chain USDC transfers
- ACH (coming soon)
Payouts are funded with your USDC denominated Circle Account, which can receive deposits from both traditional and blockchain payment rails.
func (*API) CreatePayout ¶
func (mod *API) CreatePayout(c circlesdk.CreatePayoutRequest, opts ...circlesdk.CallOption) (*circlesdk.Payout, error)
CreatePayout creates a new payout. https://developers.circle.com/reference/payouts-payouts-create
func (*API) GetPayout ¶
GetPayout returns the details of the specified payout. https://developers.circle.com/reference/payouts-payouts-get-id
func (*API) ListPayouts ¶
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 (*API) ListReturns ¶
ListReturns returns a list of returns based on the passed options. https://developers.circle.com/reference/payouts-returns-get