Documentation
¶
Overview ¶
Package core provides access to all core Circle APIs.
This core set of APIs allow you to:
- Transfer digital currency (USDC) in and out of your Circle Account.
- Register your own business bank accounts - if you have them.
- Make transfers from / to your business bank account while seamlessly converting those funds across digital currency and traditional FIAT.
Index ¶
- type API
- func (mod *API) AddRecipientAddress(addr *circlesdk.DepositAddress, desc string, opts ...circlesdk.CallOption) (string, error)
- func (mod *API) CreateDepositAddress(currency circlesdk.SupportedCurrency, chain circlesdk.SupportedChain, ...) (*circlesdk.DepositAddress, error)
- func (mod *API) GetBalance() (*circlesdk.Balance, error)
- func (mod *API) GetDepositAddressList(opts ...circlesdk.CallOption) ([]*circlesdk.DepositAddress, error)
- func (mod *API) GetMasterWalletID() (string, error)
- func (mod *API) GetPublicKey() (string, string, error)
- func (mod *API) GetRecipientAddressList(opts ...circlesdk.CallOption) ([]*circlesdk.DepositAddress, error)
- func (mod *API) Ping() bool
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 provides access to all core Circle APIs. This core set of APIs allow you to:
- Transfer digital currency (USDC) in and out of your Circle Account.
- Register your own business bank accounts - if you have them.
- Make transfers from / to your business bank account while seamlessly converting those funds across digital currency and traditional FIAT.
https://developers.circle.com/docs
func (*API) AddRecipientAddress ¶
func (mod *API) AddRecipientAddress( addr *circlesdk.DepositAddress, desc string, opts ...circlesdk.CallOption) (string, error)
AddRecipientAddress stores an external blockchain address. Once added, the recipient address must be verified to ensure that you know and trust each new address. https://developers.circle.com/reference#addresses-recipient-create
func (*API) CreateDepositAddress ¶
func (mod *API) CreateDepositAddress( currency circlesdk.SupportedCurrency, chain circlesdk.SupportedChain, opts ...circlesdk.CallOption) (*circlesdk.DepositAddress, error)
CreateDepositAddress 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#addresses-deposit-create
func (*API) GetBalance ¶
GetBalance retrieves the balance of funds that are available for use. https://developers.circle.com/reference#balances-get
func (*API) GetDepositAddressList ¶
func (mod *API) GetDepositAddressList(opts ...circlesdk.CallOption) ([]*circlesdk.DepositAddress, error)
GetDepositAddressList returns a list of all available deposit address in the account. https://developers.circle.com/reference#addresses-deposit-get
func (*API) GetMasterWalletID ¶
GetMasterWalletID return your master wallet identifier.
func (*API) GetPublicKey ¶
GetPublicKey Retrieves an RSA public key to be used in encrypting data sent to the API. Your public keys change infrequently, so we encourage you to cache this response value locally for a duration of 24 hours or more. https://developers.circle.com/reference/getpublickey
func (*API) GetRecipientAddressList ¶
func (mod *API) GetRecipientAddressList(opts ...circlesdk.CallOption) ([]*circlesdk.DepositAddress, error)
GetRecipientAddressList returns a list of recipient addresses that have each been verified and are eligible for transfers. Any recipient addresses pending verification are not included in the response. https://developers.circle.com/reference#addresses-recipient-get
Source Files