Increase.CardPurchaseSupplements (Increase v1.0.0)

Copy Markdown View Source

Additional information about a card purchase (e.g., settlement or refund), such as level 3 line item data.

See https://increase.com/documentation/api/card-purchase-supplements for the full API reference for this resource.

Summary

Functions

list(client, params \\ %{}, opts \\ [])

List Card Purchase Supplements

retrieve(client, card_purchase_supplement_id, opts \\ [])

Retrieve a Card Purchase Supplement

Functions

list(client, params \\ %{}, opts \\ [])

@spec list(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.Page.t()} | {:error, Increase.Error.t()}

List Card Purchase Supplements

Returns a %Increase.Page{} whose data is a list of %__MODULE__. CardPurchaseSupplement{} structs. Page through results with Increase.Page.auto_paging_stream/1 or Increase.Page.auto_paging_each/2.

GET /card_purchase_supplements

retrieve(client, card_purchase_supplement_id, opts \\ [])

@spec retrieve(Increase.Client.t() | keyword() | nil, String.t(), keyword()) ::
  {:ok, Increase.CardPurchaseSupplements.CardPurchaseSupplement.t()}
  | {:error, Increase.Error.t()}

Retrieve a Card Purchase Supplement

GET /card_purchase_supplements/{card_purchase_supplement_id}