Moov.Disputes (Moov v1.0.0)

Copy Markdown View Source

Manage card disputes - Visa RDR (Rapid Dispute Resolution) pre-disputes and chargebacks from any card network. Moov communicates with the networks directly and surfaces the details and deadlines here.

See https://docs.moov.io/api/money-movement/disputes/.

Summary

Functions

Accepts a dispute (concedes it without submitting evidence).

Deletes a piece of dispute evidence (before it's submitted).

Retrieves a single dispute.

Retrieves metadata about a single piece of dispute evidence.

Downloads the raw data (file bytes, or text) for a single piece of dispute evidence.

Lists disputes for an account.

Lists evidence submitted (or pending submission) for a dispute.

Finalizes and submits all uploaded evidence for a dispute to the card network.

Updates a previously uploaded piece of dispute evidence.

Uploads a file as dispute evidence (e.g. a receipt, shipping confirmation, or signed delivery form).

Submits free-text evidence for a dispute, e.g. a written explanation (params: %{text: "..."}).

Functions

accept(client, account_id, dispute_id)

@spec accept(Moov.Client.t(), String.t(), String.t()) ::
  {:ok, map()} | {:error, Moov.Error.t()}

Accepts a dispute (concedes it without submitting evidence).

delete_evidence(client, account_id, dispute_id, evidence_id)

@spec delete_evidence(Moov.Client.t(), String.t(), String.t(), String.t()) ::
  {:ok, term()} | {:error, Moov.Error.t()}

Deletes a piece of dispute evidence (before it's submitted).

get(client, account_id, dispute_id)

@spec get(Moov.Client.t(), String.t(), String.t()) ::
  {:ok, map()} | {:error, Moov.Error.t()}

Retrieves a single dispute.

get_evidence(client, account_id, dispute_id, evidence_id)

@spec get_evidence(Moov.Client.t(), String.t(), String.t(), String.t()) ::
  {:ok, map()} | {:error, Moov.Error.t()}

Retrieves metadata about a single piece of dispute evidence.

get_evidence_data(client, account_id, dispute_id, evidence_id)

@spec get_evidence_data(Moov.Client.t(), String.t(), String.t(), String.t()) ::
  {:ok, term()} | {:error, Moov.Error.t()}

Downloads the raw data (file bytes, or text) for a single piece of dispute evidence.

list(client, account_id, opts \\ [])

@spec list(Moov.Client.t(), String.t(), keyword()) ::
  {:ok, [map()]} | {:error, Moov.Error.t()}

Lists disputes for an account.

list_evidence(client, account_id, dispute_id, opts \\ [])

@spec list_evidence(Moov.Client.t(), String.t(), String.t(), keyword()) ::
  {:ok, [map()]} | {:error, Moov.Error.t()}

Lists evidence submitted (or pending submission) for a dispute.

submit_evidence(client, account_id, dispute_id)

@spec submit_evidence(Moov.Client.t(), String.t(), String.t()) ::
  {:ok, map()} | {:error, Moov.Error.t()}

Finalizes and submits all uploaded evidence for a dispute to the card network.

update_evidence(client, account_id, dispute_id, evidence_id, params)

@spec update_evidence(Moov.Client.t(), String.t(), String.t(), String.t(), map()) ::
  {:ok, map()} | {:error, Moov.Error.t()}

Updates a previously uploaded piece of dispute evidence.

upload_evidence_file(client, account_id, dispute_id, file_binary, opts)

@spec upload_evidence_file(
  Moov.Client.t(),
  String.t(),
  String.t(),
  binary(),
  keyword()
) ::
  {:ok, map()} | {:error, Moov.Error.t()}

Uploads a file as dispute evidence (e.g. a receipt, shipping confirmation, or signed delivery form).

Moov.Disputes.upload_evidence_file(client, account_id, dispute_id,
  File.read!("receipt.pdf"),
  filename: "receipt.pdf",
  content_type: "application/pdf"
)

upload_evidence_text(client, account_id, dispute_id, params)

@spec upload_evidence_text(Moov.Client.t(), String.t(), String.t(), map()) ::
  {:ok, map()} | {:error, Moov.Error.t()}

Submits free-text evidence for a dispute, e.g. a written explanation (params: %{text: "..."}).