Unit.API.Chargebacks (Unit v1.0.0)

Copy Markdown View Source

API module for Unit Chargebacks.

Chargebacks are relevant when you accept card payments via a third party and a cardholder disputes a charge. A chargeback creates a debit from an Account to a Counterparty Account and fires a transaction.created event.

Summary

Functions

create(params, opts \\ [])

Create a chargeback.

list(opts \\ [])

List chargebacks.

Functions

create(params, opts \\ [])

@spec create(
  map(),
  keyword()
) :: {:ok, Unit.Resource.Transaction.t()} | {:error, term()}

Create a chargeback.

Required params

  • :account_id
  • :counterparty_account_id
  • :amount — in cents
  • :description

list(opts \\ [])

@spec list(keyword()) ::
  {:ok, [Unit.Resource.Transaction.t()], map()} | {:error, term()}

List chargebacks.