Increase.CardDisputes (Increase v1.0.0)

Copy Markdown View Source

If unauthorized activity occurs on a card, you can create a Card Dispute and we'll work with the card networks to return the funds if appropriate.

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

Summary

Functions

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

@spec create(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.CardDisputes.CardDispute.t()} | {:error, Increase.Error.t()}

Create a Card Dispute

POST /card_disputes

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

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

List Card Disputes

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

GET /card_disputes

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

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

Retrieve a Card Dispute

GET /card_disputes/{card_dispute_id}

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

@spec submit_user_submission(
  Increase.Client.t() | keyword() | nil,
  String.t(),
  map() | keyword(),
  keyword()
) :: {:ok, Increase.CardDisputes.CardDispute.t()} | {:error, Increase.Error.t()}

Submit a User Submission for a Card Dispute

POST /card_disputes/{card_dispute_id}/submit_user_submission

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

@spec withdraw(
  Increase.Client.t() | keyword() | nil,
  String.t(),
  map() | keyword(),
  keyword()
) ::
  {:ok, Increase.CardDisputes.CardDispute.t()} | {:error, Increase.Error.t()}

Withdraw a Card Dispute

POST /card_disputes/{card_dispute_id}/withdraw