Class: StarkInfra::PixChargeback

Inherits:
StarkCore::Utils::Resource
  • Object
show all
Defined in:
lib/pixchargeback/pixchargeback.rb,
lib/pixchargeback/log.rb

Overview

# PixChargeback object

A Pix chargeback can be created when fraud is detected on a transaction or a system malfunction results in an erroneous transaction. It notifies another participant of your request to reverse the payment they have received.

When you initialize a PixChargeback, the entity will not be automatically created in the Stark Infra API. The ‘create’ function sends the objects to the Stark Infra API and returns the created object.

## Parameters (required):

  • amount [integer]: amount in cents to be reversed. ex: 11234 (= R$ 112.34)

  • reference_id [string]: end_to_end_id or return_id of the transaction to be reversed. ex: ‘E20018183202201201450u34sDGd19lz’

  • reason [string]: reason why the reversal was requested. Options: ‘fraud’, ‘flaw’, ‘reversalChargeback’

## Parameters (optional):

  • description [string, default nil]: description for the PixChargeback. ex: ‘Payment for service #1234’

  • tags [list of strings, default nil]: list of strings for tagging. ex: [‘travel’, ‘food’]

## Attributes (return-only):

  • id [string]: unique id returned when the PixChargeback is created. ex: ‘5656565656565656’

  • analysis [string]: analysis that led to the result.

  • sender_bank_code [string]: bank_code of the Pix participant that created the PixChargeback. ex: ‘20018183’

  • receiver_bank_code [string]: bank_code of the Pix participant that received the PixChargeback. ex: ‘20018183’

  • rejection_reason [string]: reason for the rejection of the Pix chargeback. Options: ‘noBalance’, ‘accountClosed’, ‘unableToReverse’

  • reversal_reference_id [string]: return id of the reversal transaction. ex: ‘D20018183202202030109X3OoBHG74wo’.

  • result [string]: result after the analysis of the PixChargeback by the receiving party. Options: ‘rejected’, ‘accepted’, ‘partiallyAccepted’

  • flow [string]: direction of the Pix Chargeback. Options: ‘in’ for received chargebacks, ‘out’ for chargebacks you requested

  • status [string]: current PixChargeback status. Options: ‘created’, ‘failed’, ‘delivered’, ‘closed’, ‘canceled’.

  • created [DateTime]: creation datetime for the PixChargeback. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)

  • updated [DateTime]: latest update datetime for the PixChargeback. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)

Defined Under Namespace

Classes: Log

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(amount:, reference_id:, reason:, description: nil, tags: nil, id: nil, analysis: nil, sender_bank_code: nil, receiver_bank_code: nil, rejection_reason: nil, reversal_reference_id: nil, result: nil, flow: nil, status: nil, created: nil, updated: nil) ⇒ PixChargeback

Returns a new instance of PixChargeback.



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/pixchargeback/pixchargeback.rb', line 41

def initialize(
  amount:, reference_id:, reason:, description: nil, tags: nil, id: nil, analysis: nil, sender_bank_code: nil,
  receiver_bank_code: nil, rejection_reason: nil, reversal_reference_id: nil, result: nil, flow: nil, status: nil,
  created: nil, updated: nil
)
  super(id)
  @amount = amount
  @reference_id = reference_id
  @reason = reason
  @description = description
  @tags = tags
  @analysis = analysis
  @sender_bank_code = sender_bank_code
  @receiver_bank_code = receiver_bank_code
  @rejection_reason = rejection_reason
  @reversal_reference_id = reversal_reference_id
  @result = result
  @flow = flow
  @status = status
  @created = StarkCore::Utils::Checks.check_datetime(created)
  @updated = StarkCore::Utils::Checks.check_datetime(updated)
end

Instance Attribute Details

#amount ⇒ Object (readonly)

Returns the value of attribute amount.



39
40
41
 
# File 'lib/pixchargeback/pixchargeback.rb', line 39

def amount
  @amount
end

#analysis ⇒ Object (readonly)

Returns the value of attribute analysis.



39
40
41
 
# File 'lib/pixchargeback/pixchargeback.rb', line 39

def analysis
  @analysis
end

#created ⇒ Object (readonly)

Returns the value of attribute created.



39
40
41
 
# File 'lib/pixchargeback/pixchargeback.rb', line 39

def created
  @created
end

#description ⇒ Object (readonly)

Returns the value of attribute description.



39
40
41
 
# File 'lib/pixchargeback/pixchargeback.rb', line 39

def description
  @description
end

#flow ⇒ Object (readonly)

Returns the value of attribute flow.



39
40
41
 
# File 'lib/pixchargeback/pixchargeback.rb', line 39

def flow
  @flow
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



39
40
41
 
# File 'lib/pixchargeback/pixchargeback.rb', line 39

def id
  @id
end

#reason ⇒ Object (readonly)

Returns the value of attribute reason.



39
40
41
 
# File 'lib/pixchargeback/pixchargeback.rb', line 39

def reason
  @reason
end

#receiver_bank_code ⇒ Object (readonly)

Returns the value of attribute receiver_bank_code.



39
40
41
 
# File 'lib/pixchargeback/pixchargeback.rb', line 39

def receiver_bank_code
  @receiver_bank_code
end

#reference_id ⇒ Object (readonly)

Returns the value of attribute reference_id.



39
40
41
 
# File 'lib/pixchargeback/pixchargeback.rb', line 39

def reference_id
  @reference_id
end

#rejection_reason ⇒ Object (readonly)

Returns the value of attribute rejection_reason.



39
40
41
 
# File 'lib/pixchargeback/pixchargeback.rb', line 39

def rejection_reason
  @rejection_reason
end

#result ⇒ Object (readonly)

Returns the value of attribute result.



39
40
41
 
# File 'lib/pixchargeback/pixchargeback.rb', line 39

def result
  @result
end

#reversal_reference_id ⇒ Object (readonly)

Returns the value of attribute reversal_reference_id.



39
40
41
 
# File 'lib/pixchargeback/pixchargeback.rb', line 39

def reversal_reference_id
  @reversal_reference_id
end

#sender_bank_code ⇒ Object (readonly)

Returns the value of attribute sender_bank_code.



39
40
41
 
# File 'lib/pixchargeback/pixchargeback.rb', line 39

def sender_bank_code
  @sender_bank_code
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



39
40
41
 
# File 'lib/pixchargeback/pixchargeback.rb', line 39

def status
  @status
end

#tags ⇒ Object (readonly)

Returns the value of attribute tags.



39
40
41
 
# File 'lib/pixchargeback/pixchargeback.rb', line 39

def tags
  @tags
end

#updated ⇒ Object (readonly)

Returns the value of attribute updated.



39
40
41
 
# File 'lib/pixchargeback/pixchargeback.rb', line 39

def updated
  @updated
end

Class Method Details

.cancel(id, user: nil) ⇒ Object

# Cancel a PixChargeback entity

Cancel a PixChargeback entity previously created in the Stark Infra API

## Parameters (required):

  • id [string]: PixChargeback unique id. ex: ‘5656565656565656’

## Parameters (optional):

  • user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call

## Return:

  • canceled PixChargeback object



206
207
208
 
# File 'lib/pixchargeback/pixchargeback.rb', line 206

def self.cancel(id, user: nil)
  StarkInfra::Utils::Rest.delete_id(id: id, user: user, **resource)
end

.create(chargebacks, user: nil) ⇒ Object

# Create PixChargebacks

Create PixChargebacks in the Stark Infra API

## Parameters (required):

  • chargebacks [list of PixChargeback objects]: list of PixChargeback objects to be created in the API.

## Parameters (optional):

  • user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call

## Return:

  • list of PixChargeback objects with updated attributes



76
77
78
 
# File 'lib/pixchargeback/pixchargeback.rb', line 76

def self.create(chargebacks, user: nil)
  StarkInfra::Utils::Rest.post(entities: chargebacks, user: user, **resource)
end

.get(id, user: nil) ⇒ Object

# Retrieve a PixChargeback object

Retrieve a PixChargeback object linked to your Workspace in the Stark Infra API using its id.

## Parameters (required):

  • id [string]: object unique id. ex: ‘5656565656565656’

## Parameters (optional):

  • user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call

## Return:

  • PixChargeback object with updated attributes



92
93
94
 
# File 'lib/pixchargeback/pixchargeback.rb', line 92

def self.get(id, user: nil)
  StarkInfra::Utils::Rest.get_id(id: id, user: user, **resource)
end

.page(cursor: nil, limit: nil, after: nil, before: nil, status: nil, ids: nil, flow: nil, tags: nil, user: nil) ⇒ Object

# Retrieve paged PixChargebacks

Receive a list of up to 100 PixChargeback objects previously created in the Stark infra API and the cursor to the next page. Use this function instead of query if you want to manually page your chargebacks.

## Parameters (optional):

  • cursor [string, default nil]: cursor returned on the previous page function call

  • limit [integer, default 100]: maximum number of objects to be retrieved. Max = 100. ex: 35

  • after [Date or string, default nil]: date filter for objects created or updated only after specified date. ex: Date.new(2020, 3, 10)

  • before [Date or string, default nil]: date filter for objects created or updated only before specified date. ex: Date.new(2020, 3, 10)

  • status [string, default nil]: filter for status of retrieved objects. ex: ‘success’ or ‘failed’

  • ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: [‘5656565656565656’, ‘4545454545454545’]

  • flow [string, default nil]: direction of the Pix Chargeback. Options: ‘in’ for received chargebacks, ‘out’ for chargebacks you requested

  • tags [list of strings, default nil]: filter for tags of retrieved objects. ex: [‘travel’, ‘food’]

  • user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call

## Return:

  • list of PixChargeback objects with updated attributes

  • cursor to retrieve the next page of PixChargeback objects



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/pixchargeback/pixchargeback.rb', line 147

def self.page(cursor: nil, limit: nil, after: nil, before: nil, status: nil, ids: nil, flow: nil, tags: nil, user: nil)
  after = StarkCore::Utils::Checks.check_date(after)
  before = StarkCore::Utils::Checks.check_date(before)
  StarkInfra::Utils::Rest.get_page(
    cursor: cursor,
    limit: limit,
    after: after,
    before: before,
    status: status,
    ids: ids,
    flow: flow,
    tags: tags,
    user: user,
    **resource
  )
end

.query(limit: nil, after: nil, before: nil, status: nil, ids: nil, flow: nil, tags: nil, user: nil) ⇒ Object

# Retrieve PixChargebacks

Receive a generator of PixChargeback objects previously created in the Stark Infra API

## Parameters (optional):

  • limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35

  • after [Date or string, default nil]: date filter for objects created or updated only after specified date. ex: Date.new(2020, 3, 10)

  • before [Date or string, default nil]: date filter for objects created or updated only before specified date. ex: Date.new(2020, 3, 10)

  • status [string, default nil]: filter for status of retrieved objects. ex: ‘success’ or ‘failed’

  • ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: [‘5656565656565656’, ‘4545454545454545’]

  • flow [string, default nil]: direction of the Pix Chargeback. Options: ‘in’ for received chargebacks, ‘out’ for chargebacks you requested

  • tags [list of strings, default nil]: filter for tags of retrieved objects. ex: [‘travel’, ‘food’]

  • user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call

## Return:

  • generator of PixChargeback objects with updated attributes



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/pixchargeback/pixchargeback.rb', line 112

def self.query(limit: nil, after: nil, before: nil, status: nil, ids: nil, flow: nil, tags: nil, user: nil)
  after = StarkCore::Utils::Checks.check_date(after)
  before = StarkCore::Utils::Checks.check_date(before)
  StarkInfra::Utils::Rest.get_stream(
    limit: limit,
    after: after,
    before: before,
    status: status,
    ids: ids,
    flow: flow,
    tags: tags,
    user: user,
    **resource
  )
end

.resource ⇒ Object 



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/pixchargeback/pixchargeback.rb', line 210

def self.resource
  {
    resource_name: 'PixChargeback',
    resource_maker: proc { |json|
      PixChargeback.new(
        id: json['id'],
        amount: json['amount'],
        reference_id: json['reference_id'],
        reason: json['reason'],
        description: json['description'],
        tags: json['tags'],
        analysis: json['analysis'],
        sender_bank_code: json['sender_bank_code'],
        receiver_bank_code: json['receiver_bank_code'],
        rejection_reason: json['rejection_reason'],
        reversal_reference_id: json['reversal_reference_id'],
        result: json['result'],
        flow: json['flow'],
        status: json['status'],
        created: json['created'],
        updated: json['updated']
      )
    }
  }
end

.update(id, result:, rejection_reason: nil, reversal_reference_id: nil, analysis: nil, user: nil) ⇒ Object

# Update a PixChargeback entity

Respond to a received PixChargeback.

## Parameters (required):

  • id [string]: PixChargeback unique id. ex: ‘5656565656565656’

  • result [string]: result after the analysis of the PixChargeback. Options: ‘rejected’, ‘accepted’, ‘partiallyAccepted’.

## Parameters (conditionally required):

  • rejection_reason [string, default nil]: if the PixChargeback is rejected a reason is required. Options: ‘noBalance’, ‘accountClosed’, ‘unableToReverse’,

  • reversal_reference_id [string, default nil]: return_id of the reversal transaction. ex: ‘D20018183202201201450u34sDGd19lz’

## Parameters (optional):

  • analysis [string, default nil]: description of the analysis that led to the result.

  • user [Organization/Project object, default nil]: Organization or Project object. Not necessary if StarkInfra.user was set before function call

## Return:

  • updated PixChargeback object



182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/pixchargeback/pixchargeback.rb', line 182

def self.update(id, result:, rejection_reason: nil, reversal_reference_id: nil, analysis: nil, user: nil)
  StarkInfra::Utils::Rest.patch_id(
    id: id,
    result: result,
    rejection_reason: rejection_reason,
    reversal_reference_id: reversal_reference_id,
    analysis: analysis,
    user: user,
    **resource
  )
end