Polarex.Wallets (Polarex v0.3.1)

Copy Markdown View Source

Provides API endpoints related to wallets

Summary

Functions

customer_portal_wallets_get(id, opts \\ [])

@spec customer_portal_wallets_get(id :: String.t(), opts :: keyword()) ::
  {:ok, Polarex.CustomerWallet.t()}
  | {:error, Polarex.HTTPValidationError.t() | Polarex.ResourceNotFound.t()}

Get Wallet

Get a wallet by ID for the authenticated customer.

customer_portal_wallets_list(opts \\ [])

@spec customer_portal_wallets_list(opts :: keyword()) ::
  {:ok, Polarex.ListResourceCustomerWallet.t()}
  | {:error, Polarex.HTTPValidationError.t()}

List Wallets

List wallets of the authenticated customer.

Options

  • page: Page number, defaults to 1.
  • limit: Size of a page, defaults to 10. Maximum is 100.
  • sorting: Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign - before the criteria name to sort by descending order.