DodoPayments.Balances (dodo_payments v0.1.0)

Copy Markdown View Source

Merchant balance ledger history.

Summary

Types

list_ledger_params()

Parameters for balance_ledger_list. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/balances.ts declaration BalanceRetrieveLedgerParams.

Functions

list_ledger(client)

Calls Dodo operation balance_ledger_list (GET /balances/ledger). Required parameters: none. Numbered pagination is zero-based.

list_ledger(client, opts)

Calls Dodo operation balance_ledger_list (GET /balances/ledger). Required parameters: none. Numbered pagination is zero-based.

list_ledger(client, params, opts)

Calls Dodo operation balance_ledger_list (GET /balances/ledger). Required parameters: none. Numbered pagination is zero-based.

Types

list_ledger_params()

@type list_ledger_params() ::
  %{
    optional(:page_number) => number(),
    optional(:page_size) => number(),
    optional(:created_at_gte) => String.t(),
    optional(:created_at_lte) => String.t(),
    optional(:currency) => DodoPayments.Enums.currency(),
    optional(:event_type) => DodoPayments.Enums.balance_event_type(),
    optional(:limit) => number(),
    optional(:reference_object_id) => String.t(),
    optional(String.t()) => DodoPayments.RequestTypes.input_value()
  }
  | DodoPayments.RequestTypes.compatibility_params()

Parameters for balance_ledger_list. Exact fields use atom keys; string-keyed and mixed-key maps remain supported. Source: locked upstream resources/balances.ts declaration BalanceRetrieveLedgerParams.

Functions

list_ledger(client)

@spec list_ledger(DodoPayments.Client.t()) ::
  {:ok, DodoPayments.Page.Numbered.t(DodoPayments.BalanceLedgerEntry.t())}
  | {:error, Exception.t()}

Calls Dodo operation balance_ledger_list (GET /balances/ledger). Required parameters: none. Numbered pagination is zero-based.

Calls the operation with an empty parameter map.

list_ledger(client, opts)

@spec list_ledger(DodoPayments.Client.t(), list_ledger_params() | nil | keyword()) ::
  {:ok,
   DodoPayments.Page.Numbered.t(DodoPayments.BalanceLedgerEntry.t())
   | DodoPayments.Response.t(
       DodoPayments.Page.Numbered.t(DodoPayments.BalanceLedgerEntry.t())
     )}
  | {:error, Exception.t()}

Calls Dodo operation balance_ledger_list (GET /balances/ledger). Required parameters: none. Numbered pagination is zero-based.

Pass a map for Dodo parameters or a keyword list for request-local options.

list_ledger(client, params, opts)

@spec list_ledger(DodoPayments.Client.t(), list_ledger_params() | nil, keyword()) ::
  {:ok,
   DodoPayments.Page.Numbered.t(DodoPayments.BalanceLedgerEntry.t())
   | DodoPayments.Response.t(
       DodoPayments.Page.Numbered.t(DodoPayments.BalanceLedgerEntry.t())
     )}
  | {:error, Exception.t()}

Calls Dodo operation balance_ledger_list (GET /balances/ledger). Required parameters: none. Numbered pagination is zero-based.

Accepts both a Dodo parameter map and request-local options.