accounts

Documentation

Overview

Package accounts provides access to Circle's Accounts APIs.

The API allows you to easily create and manage accounts and balances for your customers, and execute transfers of funds across accounts - whether they are within the Circle platform, or in / out of the platform via on-chain USDC connectivity.

• Accept USDC deposits with minimum cost and no exposure to reversals.
• Support BTC and ETH balances in addition to USDC.
• Embed US Dollar denominated accounts into your product or service without dealing with the complexity of legacy bank account structures.
• Manage a multi-asset accounts infrastructure for your customers including seamless transfer of funds, across hosted accounts or via on-chain USDC connectivity.

Index

• type API
  • func (mod *API) CreateWallet(description string, opts ...circlesdk.CallOption) (*circlesdk.Wallet, error)
  • func (mod *API) CreateWalletDepositAddress(walletID string, currency circlesdk.SupportedCurrency, ...) (*circlesdk.DepositAddress, error)
  • func (mod *API) GetTransfersList(walletID string, opts ...circlesdk.CallOption) ([]*circlesdk.Transfer, error)
  • func (mod *API) GetWallet(id string, opts ...circlesdk.CallOption) (*circlesdk.Wallet, error)
  • func (mod *API) GetWalletAddressList(id string, opts ...circlesdk.CallOption) ([]*circlesdk.DepositAddress, error)
  • func (mod *API) GetWalletsList(opts ...circlesdk.CallOption) ([]*circlesdk.Wallet, error)

Types

type API

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

API the Circle Accounts API allows you to easily create and manage accounts and balances for your customers, and execute transfers of funds across accounts - whether they are within the Circle platform, or in / out of the platform via on-chain USDC connectivity.

• Embed US Dollar denominated accounts into your product or service without dealing with the complexity of legacy bank account structures.
• Manage a multi-asset accounts infrastructure for your customers including seamless transfer of funds, across hosted accounts or via on-chain USDC connectivity.
• Accept USDC deposits with minimum cost and no exposure to reversals.
• Support BTC and ETH balances in addition to USDC.

func (*API) CreateWallet

func (mod *API) CreateWallet(description string, opts ...circlesdk.CallOption) (*circlesdk.Wallet, error)

CreateWallet creates a new end user wallet. https://developers.circle.com/reference#accounts-wallets-create

func (*API) CreateWalletDepositAddress

func (mod *API) CreateWalletDepositAddress(
	walletID string,
	currency circlesdk.SupportedCurrency,
	chain circlesdk.SupportedChain,
	opts ...circlesdk.CallOption) (*circlesdk.DepositAddress, error)

CreateWalletDepositAddress generates a new blockchain address for a wallet for a given currency/chain pair. Circle may reuse addresses on blockchains that support reuse. For example, if you're requesting two addresses for depositing USD and ETH, both on Ethereum, you may see the same Ethereum address returned. Depositing cryptocurrency to a generated address will credit the associated wallet with the value of the deposit. https://developers.circle.com/reference#accounts-wallets-addresses-create

func (*API) GetTransfersList

func (mod *API) GetTransfersList(walletID string, opts ...circlesdk.CallOption) ([]*circlesdk.Transfer, error)

GetTransfersList searches for transfers involving the provided wallet. `walletID` should be the unique identifier for the source or destination wallet of transfers; useful for fetching all transfers related to a wallet. If no wallet ids are provided, searches all wallets associated with your Circle API account. If the date parameters are omitted, returns the most recent transfers. This endpoint returns up to 50 transfers in descending chronological order or pageSize, if provided. https://developers.circle.com/reference#accounts-transfers-get

func (*API) GetWallet

func (mod *API) GetWallet(id string, opts ...circlesdk.CallOption) (*circlesdk.Wallet, error)

GetWallet retrieves the full details of a given wallet. https://developers.circle.com/reference#accounts-wallets-get-id

func (*API) GetWalletAddressList

func (mod *API) GetWalletAddressList(id string, opts ...circlesdk.CallOption) ([]*circlesdk.DepositAddress, error)

GetWalletAddressList retrieves a list of addresses associated with a wallet. https://developers.circle.com/reference#accounts-wallets-addresses-get

func (*API) GetWalletsList

func (mod *API) GetWalletsList(opts ...circlesdk.CallOption) ([]*circlesdk.Wallet, error)

GetWalletsList retrieves a list of a user's wallets. https://developers.circle.com/reference#accounts-wallets-get