bnkdev

Documentation

Index

• type Account
• type Client
  • func NewClient(key string) *Client
  • func (c *Client) ListAccounts(ctx context.Context) (*ListAccountsResponse, error)
  • func (c *Client) ListTransactions(ctx context.Context, r *ListTransactionsRequest) (*ListTransactionsResponse, error)
• type Error
  • func (e Error) Error() string
• type ListAccountsResponse
• type ListTransactionsRequest
• type ListTransactionsResponse
• type ResponseMetadata
• type Transaction

Types

type Account

type Account struct {
	ID string `json:"id,omitempty"` // The account identifier.

	// The current balance of the account in the minor unit of the currency.
	// For dollars, for example, this is cents.
	Balance int `json:"balance,omitempty"`

	// The identifier for the entity this account belongs to.
	EntityID string `json:"entity_id,omitempty"`

	// The interest accrued but not yet paid.
	InterestAccrued string `json:"interest_accrued,omitempty"`

	// The latest ISO 8601 date on which interest was accrued.
	InterestAccruedAt string `json:"interest_accrued_at,omitempty"`

	// The account path that can be used in the API or your dashboard.
	Path string `json:"path,omitempty"`

	Currency string `json:"currency,omitempty"` // The ISO 4217 code for the account currency.
	Name     string `json:"name,omitempty"`     // The name you chose for the account.
}

Accounts are your bank accounts with bnk.dev. They can store money and receive & originate transfers.

type Client

type Client struct {
	Base            string
	HTTP            http.Client
	EnableTelemetry bool
	// contains filtered or unexported fields
}

func NewClient

func NewClient(key string) *Client

func (*Client) ListAccounts

func (c *Client) ListAccounts(ctx context.Context) (*ListAccountsResponse, error)

Returns a list of agent objects that match the provided query.

func (*Client) ListTransactions

func (c *Client) ListTransactions(ctx context.Context, r *ListTransactionsRequest) (*ListTransactionsResponse, error)

Returns a list of agent objects that match the provided query.

type Error

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

func (Error) Error

func (e Error) Error() string

type ListAccountsResponse

type ListAccountsResponse struct {
	Data             []Account        `json:"data,omitempty"`
	ResponseMetadata ResponseMetadata `json:"response_metadata,omitempty"`
}

type ListTransactionsRequest

type ListTransactionsRequest struct {
	AccountID string `json:"account_id,omitempty"`
}

type ListTransactionsResponse

type ListTransactionsResponse struct {
	Data             []Transaction    `json:"data,omitempty"`
	ResponseMetadata ResponseMetadata `json:"response_metadata,omitempty"`
}

type ResponseMetadata

type ResponseMetadata struct {
	NextCursor string `json:"next_cursor,omitempty"`
}

type Transaction

type Transaction struct {
	ID string `json:"id,omitempty"` // The account identifier.

	// The identifier for the account this transaction belongs to.
	AccountID string `json:"account_id,omitempty"`

	// The transaction amount in the minor unit of the account currency. For
	// dollars, for example, this is cents.
	Amount int `json:"amount,omitempty"`

	// For a transaction related to a transfer, this is the description you
	// provide. For a transaction related to a payment, this is the
	// description the vendor provides.
	Description string `json:"description,omitempty"`

	// The transaction path that can be used in the API or your dashboard.
	Path string `json:"path,omitempty"`

	// The identifier for the route this transaction came through. Routes are
	// things like cards and ACH details.
	RouteID string `json:"route_id,omitempty"`

	// This is an object giving more details on the network-level event that
	// caused the transaction. For example, for a card transaction this lists
	// the merchant's industry and location.
	Source json.RawMessage `json:"source,omitempty"`

	Date string `json:"date,omitempty"` // The ISO 8601 date on which the transaction occured.
}

Transactions are the immutable additions and removals of money from your bank account.