Increase.CardDisputes.CardDispute (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.

Fields

  • id - The Card Dispute identifier.
  • amount - The amount of the dispute.
  • card_id - The Card that the Card Dispute is associated with.
  • created_at - The ISO 8601 date and time at which the Card Dispute was created.
  • disputed_transaction_id - The identifier of the Transaction that was disputed.
  • idempotency_key - The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.
  • loss - If the Card Dispute's status is lost, this will contain details of the lost dispute.
  • network - The network that the Card Dispute is associated with.
  • rejection - If the Card Dispute has been rejected, this will contain details of the rejection.
  • status - The status of the Card Dispute.
  • type - A constant representing the object's type. For this resource it will always be card_dispute.
  • user_submission_required_by - The ISO 8601 date and time at which the user submission is required by. Present only if status is user_submission_required and a user submission is required by a certain time. Otherwise, this will be nil.
  • visa - Card Dispute information for card payments processed over Visa's network. This field will be present in the JSON response if and only if network is equal to visa.
  • win - If the Card Dispute's status is won, this will contain details of the won dispute.
  • withdrawal - If the Card Dispute has been withdrawn, this will contain details of the withdrawal.

Summary

Types

t()

Types

t()

@type t() :: %Increase.CardDisputes.CardDispute{
  amount: integer(),
  card_id: String.t(),
  created_at: DateTime.t(),
  disputed_transaction_id: String.t(),
  id: String.t(),
  idempotency_key: String.t() | nil,
  loss: Increase.CardDisputes.CardDispute.Loss.t() | nil,
  network: String.t(),
  rejection: Increase.CardDisputes.CardDispute.Rejection.t() | nil,
  status: String.t(),
  type: String.t(),
  user_submission_required_by: DateTime.t() | nil,
  visa: Increase.CardDisputes.CardDispute.Visa.t() | nil,
  win: Increase.CardDisputes.CardDispute.Win.t() | nil,
  withdrawal: Increase.CardDisputes.CardDispute.Withdrawal.t() | nil
}