Increase.CardPayments (Increase v1.0.0)

Copy Markdown View Source

Card Payments group together interactions related to a single card payment, such as an authorization and its corresponding settlement.

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

Summary

Functions

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

List Card Payments

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

Retrieve a Card Payment

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 Payments

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

GET /card_payments

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

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

Retrieve a Card Payment

GET /card_payments/{card_payment_id}