Class: Increase::Models::CardDispute

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/card_dispute.rb

Overview

See Also:

Defined Under Namespace

Modules: Network, Status, Type Classes: Loss, Visa, Win

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id: , amount: , card_id: , created_at: , disputed_transaction_id: , idempotency_key: , loss: , network: , status: , type: , user_submission_required_by: , visa: , win: ) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::CardDispute for more details.

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.

Parameters:

  • id (String) (defaults to: ) —

    The Card Dispute identifier.

  • amount (Integer) (defaults to: ) —

    The amount of the dispute.

  • card_id (String) (defaults to: ) —

    The Card that the Card Dispute is associated with.

  • created_at (Time) (defaults to: ) —

    The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time at which th

  • disputed_transaction_id (String) (defaults to: ) —

    The identifier of the Transaction that was disputed.

  • idempotency_key (String, nil) (defaults to: ) —

    The idempotency key you chose for this object. This value is unique across Incre

  • loss (Increase::Models::CardDispute::Loss, nil) (defaults to: ) —

    If the Card Dispute’s status is ‘lost`, this will contain details of the lost di

  • network (Symbol, Increase::Models::CardDispute::Network) (defaults to: ) —

    The network that the Card Dispute is associated with.

  • status (Symbol, Increase::Models::CardDispute::Status) (defaults to: ) —

    The status of the Card Dispute.

  • type (Symbol, Increase::Models::CardDispute::Type) (defaults to: ) —

    A constant representing the object’s type. For this resource it will always be ‘

  • user_submission_required_by (Time, nil) (defaults to: ) —

    The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time at which th

  • visa (Increase::Models::CardDispute::Visa, nil) (defaults to: ) —

    Card Dispute information for card payments processed over Visa’s network. This f

  • win (Increase::Models::CardDispute::Win, nil) (defaults to: ) —

    If the Card Dispute’s status is ‘won`, this will contain details of the won disp




# File 'lib/increase/models/card_dispute.rb', line 96

Instance Attribute Details

#amount ⇒ Integer

The amount of the dispute.

Returns:

  • (Integer) 


17
 
# File 'lib/increase/models/card_dispute.rb', line 17

required :amount, Integer

#card_id ⇒ String

The Card that the Card Dispute is associated with.

Returns:

  • (String) 


23
 
# File 'lib/increase/models/card_dispute.rb', line 23

required :card_id, String

#created_at ⇒ Time

The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was created.

Returns:

  • (Time) 


30
 
# File 'lib/increase/models/card_dispute.rb', line 30

required :created_at, Time

#disputed_transaction_id ⇒ String

The identifier of the Transaction that was disputed.

Returns:

  • (String) 


36
 
# File 'lib/increase/models/card_dispute.rb', line 36

required :disputed_transaction_id, String

#id ⇒ String

The Card Dispute identifier.

Returns:

  • (String) 


11
 
# File 'lib/increase/models/card_dispute.rb', line 11

required :id, String

#idempotency_key ⇒ String?

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](increase.com/documentation/idempotency-keys).

Returns:

  • (String, nil) 


44
 
# File 'lib/increase/models/card_dispute.rb', line 44

required :idempotency_key, String, nil?: true

#loss ⇒ Increase::Models::CardDispute::Loss?

If the Card Dispute’s status is ‘lost`, this will contain details of the lost dispute.

Returns:



51
 
# File 'lib/increase/models/card_dispute.rb', line 51

required :loss, -> { Increase::CardDispute::Loss }, nil?: true

#network ⇒ Symbol, Increase::Models::CardDispute::Network

The network that the Card Dispute is associated with.

Returns:



57
 
# File 'lib/increase/models/card_dispute.rb', line 57

required :network, enum: -> { Increase::CardDispute::Network }

#status ⇒ Symbol, Increase::Models::CardDispute::Status

The status of the Card Dispute.

Returns:



63
 
# File 'lib/increase/models/card_dispute.rb', line 63

required :status, enum: -> { Increase::CardDispute::Status }

#type ⇒ Symbol, Increase::Models::CardDispute::Type

A constant representing the object’s type. For this resource it will always be ‘card_dispute`.

Returns:



70
 
# File 'lib/increase/models/card_dispute.rb', line 70

required :type, enum: -> { Increase::CardDispute::Type }

#user_submission_required_by ⇒ Time?

The [ISO 8601](en.wikipedia.org/wiki/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`.

Returns:

  • (Time, nil) 


79
 
# File 'lib/increase/models/card_dispute.rb', line 79

required :user_submission_required_by, Time, nil?: true

#visa ⇒ Increase::Models::CardDispute::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`.

Returns:



87
 
# File 'lib/increase/models/card_dispute.rb', line 87

required :visa, -> { Increase::CardDispute::Visa }, nil?: true

#win ⇒ Increase::Models::CardDispute::Win?

If the Card Dispute’s status is ‘won`, this will contain details of the won dispute.

Returns:



94
 
# File 'lib/increase/models/card_dispute.rb', line 94

required :win, -> { Increase::CardDispute::Win }, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/card_dispute.rb', line 167