Class: StarkBank::CorporatePurchase

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

Overview

# CorporatePurchase object

Displays the CorporatePurchase objects created in your Workspace.

## Attributes (return-only):

  • id [string]: unique id returned when CorporatePurchase is created. ex: “5656565656565656”

  • holder_id [string]: card holder unique id. ex: “5656565656565656”

  • holder_name [string]: card holder name. ex: “Tony Stark”

  • center_id [string]: target cost center ID. ex: “5656565656565656”

  • card_id [string]: unique id returned when CorporateCard is created. ex: “5656565656565656”

  • card_ending [string]: last 4 digits of the card number. ex: “1234”

  • description [string]: purchase descriptions. ex: “my_description”

  • amount [integer]: CorporatePurchase value in cents. Minimum = 0. ex: 1234 (= R$ 12.34)

  • tax [integer]: IOF amount taxed for international purchases. ex: 1234 (= R$ 12.34)

  • corporate_amount [integer]: corporate amount. ex: 1234 (= R$ 12.34)

  • corporate_currency_code [string]: corporate currency code. ex: “USD”

  • corporate_currency_symbol [string]: corporate currency symbol. ex: “$”

  • merchant_amount [integer]: merchant amount. ex: 1234 (= R$ 12.34)

  • merchant_currency_code [string]: merchant currency code. ex: “USD”

  • merchant_currency_symbol [string]: merchant currency symbol. ex: “$”

  • merchant_category_code [string]: merchant category code. ex: “fastFoodRestaurants”

  • merchant_category_type [string]: merchant category type. ex: “health”

  • merchant_country_code [string]: merchant country code. ex: “USA”

  • merchant_name [string]: merchant name. ex: “Google Cloud Platform”

  • merchant_display_name [string]: merchant name. ex: “Google Cloud Platform”

  • merchant_display_url [string]: public merchant icon (png image). ex: “”

  • merchant_fee [integer]: fee charged by the merchant to cover specific costs, such as ATM withdrawal logistics, etc. ex: 200 (= R$ 2.00)

  • method_code [string]: method code. Options: “chip”, “token”, “server”, “manual”, “magstripe” or “contactless”

  • tags [list of strings]: list of strings for tagging returned by the sub-issuer during the authorization. ex: [“travel”, “food”]

  • corporate_transaction_ids [list of strings]: ledger transaction ids linked to this Purchase

  • status [string]: current CorporateCard status. Options: “approved”, “canceled”, “denied”, “confirmed”, “voided”

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

  • created [DateTime]: creation datetime for the CorporatePurchase. ex: DateTime(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(id: nil, holder_id: nil, holder_name: nil, center_id: nil, card_id: nil, card_ending: nil, description: nil, amount: nil, tax: nil, corporate_amount: nil, corporate_currency_code: nil, corporate_currency_symbol: nil, merchant_amount: nil, merchant_currency_code: nil, merchant_currency_symbol: nil, merchant_category_code: nil, merchant_category_type: nil, merchant_country_code: nil, merchant_name: nil, merchant_display_name: nil, merchant_display_url: nil, merchant_fee: nil, method_code: nil, tags: nil, corporate_transaction_ids: nil, status: nil, updated: nil, created: nil) ⇒ CorporatePurchase

Returns a new instance of CorporatePurchase.



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 45

def initialize(
  id: nil, holder_id: nil, holder_name: nil, center_id: nil, card_id: nil, card_ending: nil, description: nil, amount: nil, tax: nil, corporate_amount: nil,
  corporate_currency_code: nil, corporate_currency_symbol: nil, merchant_amount: nil, merchant_currency_code: nil, merchant_currency_symbol: nil,
  merchant_category_code: nil, merchant_category_type: nil, merchant_country_code: nil, merchant_name: nil, merchant_display_name: nil,
  merchant_display_url: nil, merchant_fee: nil, method_code: nil, tags: nil, corporate_transaction_ids: nil, status: nil, updated: nil, created: nil
)
  super(id)
  @holder_id = holder_id
  @holder_name = holder_name
  @center_id = center_id
  @card_id = card_id
  @card_ending = card_ending
  @description = description
  @amount = amount
  @tax = tax
  @corporate_amount = corporate_amount
  @corporate_currency_code = corporate_currency_code
  @corporate_currency_symbol = corporate_currency_symbol
  @merchant_amount = merchant_amount
  @merchant_currency_code = merchant_currency_code
  @merchant_currency_symbol = merchant_currency_symbol
  @merchant_category_code = merchant_category_code
  @merchant_category_type = merchant_category_type
  @merchant_country_code = merchant_country_code
  @merchant_name = merchant_name
  @merchant_display_name = merchant_display_name
  @merchant_display_url = merchant_display_url
  @merchant_fee = merchant_fee
  @method_code = method_code
  @tags = tags
  @corporate_transaction_ids = corporate_transaction_ids
  @status = status
  @updated = updated
  @created = created

end

Instance Attribute Details

#amount ⇒ Object (readonly)

Returns the value of attribute amount.



41
42
43
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 41

def amount
  @amount
end

#card_ending ⇒ Object (readonly)

Returns the value of attribute card_ending.



41
42
43
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 41

def card_ending
  @card_ending
end

#card_id ⇒ Object (readonly)

Returns the value of attribute card_id.



41
42
43
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 41

def card_id
  @card_id
end

#center_id ⇒ Object (readonly)

Returns the value of attribute center_id.



41
42
43
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 41

def center_id
  @center_id
end

#corporate_amount ⇒ Object (readonly)

Returns the value of attribute corporate_amount.



41
42
43
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 41

def corporate_amount
  @corporate_amount
end

#corporate_currency_code ⇒ Object (readonly)

Returns the value of attribute corporate_currency_code.



41
42
43
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 41

def corporate_currency_code
  @corporate_currency_code
end

#corporate_currency_symbol ⇒ Object (readonly)

Returns the value of attribute corporate_currency_symbol.



41
42
43
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 41

def corporate_currency_symbol
  @corporate_currency_symbol
end

#corporate_transaction_ids ⇒ Object (readonly)

Returns the value of attribute corporate_transaction_ids.



41
42
43
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 41

def corporate_transaction_ids
  @corporate_transaction_ids
end

#created ⇒ Object (readonly)

Returns the value of attribute created.



41
42
43
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 41

def created
  @created
end

#description ⇒ Object (readonly)

Returns the value of attribute description.



41
42
43
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 41

def description
  @description
end

#holder_id ⇒ Object (readonly)

Returns the value of attribute holder_id.



41
42
43
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 41

def holder_id
  @holder_id
end

#holder_name ⇒ Object (readonly)

Returns the value of attribute holder_name.



41
42
43
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 41

def holder_name
  @holder_name
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



41
42
43
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 41

def id
  @id
end

#merchant_amount ⇒ Object (readonly)

Returns the value of attribute merchant_amount.



41
42
43
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 41

def merchant_amount
  @merchant_amount
end

#merchant_category_code ⇒ Object (readonly)

Returns the value of attribute merchant_category_code.



41
42
43
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 41

def merchant_category_code
  @merchant_category_code
end

#merchant_category_type ⇒ Object (readonly)

Returns the value of attribute merchant_category_type.



41
42
43
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 41

def merchant_category_type
  @merchant_category_type
end

#merchant_country_code ⇒ Object (readonly)

Returns the value of attribute merchant_country_code.



41
42
43
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 41

def merchant_country_code
  @merchant_country_code
end

#merchant_currency_code ⇒ Object (readonly)

Returns the value of attribute merchant_currency_code.



41
42
43
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 41

def merchant_currency_code
  @merchant_currency_code
end

#merchant_currency_symbol ⇒ Object (readonly)

Returns the value of attribute merchant_currency_symbol.



41
42
43
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 41

def merchant_currency_symbol
  @merchant_currency_symbol
end

#merchant_display_name ⇒ Object (readonly)

Returns the value of attribute merchant_display_name.



41
42
43
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 41

def merchant_display_name
  @merchant_display_name
end

#merchant_display_url ⇒ Object (readonly)

Returns the value of attribute merchant_display_url.



41
42
43
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 41

def merchant_display_url
  @merchant_display_url
end

#merchant_fee ⇒ Object (readonly)

Returns the value of attribute merchant_fee.



41
42
43
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 41

def merchant_fee
  @merchant_fee
end

#merchant_name ⇒ Object (readonly)

Returns the value of attribute merchant_name.



41
42
43
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 41

def merchant_name
  @merchant_name
end

#method_code ⇒ Object (readonly)

Returns the value of attribute method_code.



41
42
43
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 41

def method_code
  @method_code
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



41
42
43
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 41

def status
  @status
end

#tags ⇒ Object (readonly)

Returns the value of attribute tags.



41
42
43
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 41

def tags
  @tags
end

#tax ⇒ Object (readonly)

Returns the value of attribute tax.



41
42
43
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 41

def tax
  @tax
end

#updated ⇒ Object (readonly)

Returns the value of attribute updated.



41
42
43
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 41

def updated
  @updated
end

Class Method Details

.get(id, user: nil) ⇒ Object

# Retrieve a specific CorporatePurchase

Receive a single CorporatePurchase object previously created in the Stark Bank API by 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 StarkBank.user was set before function call

## Return:

  • CorporatePurchase object with updated attributes



94
95
96
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 94

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

.page(cursor: nil, ids: nil, limit: nil, after: nil, before: nil, merchant_category_types: nil, holder_ids: nil, card_ids: nil, status: nil, user: nil) ⇒ Object

# Retrieve paged CorporatePurchases

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

## 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 only after specified date. ex: Date.new(2020, 3, 10)

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

  • merchant_category_types [list of strings, default nil]: merchant category type. ex: “health”

  • holder_ids [list of strings, default nil]: card holder IDs. ex: [“5656565656565656”, “4545454545454545”]

  • card_ids [list of strings, default nil]: card IDs. ex: [“5656565656565656”, “4545454545454545”]

  • status [list of strings, default nil]: filter for status of retrieved objects. ex: [‘approved’, ‘canceled’, ‘denied’, ‘confirmed’, ‘voided’]

  • ids [list of strings, default nil]: purchase IDs. ex: [‘5656565656565656’, ‘4545454545454545’]

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

## Return:

  • list of CorporatePurchases objects with updated attributes

  • cursor to retrieve the next page of CorporatePurchases objects



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 153

def self.page(cursor: nil, ids: nil, limit: nil, after: nil, before: nil, merchant_category_types: nil, holder_ids: nil,
              card_ids: nil, status: nil, user: nil)
  after = StarkCore::Utils::Checks.check_date(after)
  before = StarkCore::Utils::Checks.check_date(before)
  StarkBank::Utils::Rest.get_page(
    cursor: cursor,
    ids: ids,
    limit: limit,
    after: after,
    before: before,
    merchant_category_types: merchant_category_types,
    holder_ids: holder_ids,
    card_ids: card_ids,
    status: status,
    user: user,
    **resource
  )
end

.parse(content:, signature:, user: nil) ⇒ Object

# Create a single verified CorporatePurchase authorization request from a content string

Use this method to parse and verify the authenticity of the authorization request received at the informed endpoint. Authorization requests are posted to your registered endpoint whenever CorporatePurchases are received. They present CorporatePurchase data that must be analyzed and answered with approval or declination. If the provided digital signature does not check out with the StarkBank public key, a stark.exception.InvalidSignatureException will be raised. If the authorization request is not answered within 2 seconds or is not answered with an HTTP status code 200 the CorporatePurchase will go through the pre-configured stand-in validation.

## Parameters (required):

  • content [string]: response content from request received at user endpoint (not parsed)

  • signature [string]: base-64 digital signature received at response header ‘Digital-Signature’

# ## Parameters (optional):

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

## Return:

  • Parsed CorporatePurchase object



190
191
192
193
194
195
196
197
198
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 190

def self.parse(content:, signature:, user: nil)
  StarkBank::Utils::Parse.parse_and_verify(
    content: content,
    signature: signature,
    user: user,
    key: nil,
    resource: resource
  )
end

.query(ids: nil, limit: nil, after: nil, before: nil, merchant_category_types: nil, holder_ids: nil, card_ids: nil, status: nil, user: nil) ⇒ Object

# Retrieve CorporatePurchases

Receive a generator of CorporatePurchases objects previously created in the Stark Bank 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 only after specified date. ex: Date.new(2020, 3, 09)

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

  • merchant_category_types [list of strings, default nil]: merchant category type. ex: “health”

  • holder_ids [list of strings, default nil]: card holder IDs. ex: [“5656565656565656”, “4545454545454545”]

  • card_ids [list of strings, default nil]: card IDs. ex: [“5656565656565656”, “4545454545454545”]

  • status [list of strings, default nil]: filter for status of retrieved objects. ex: [‘approved’, ‘canceled’, ‘denied’, ‘confirmed’, ‘voided’]

  • ids [list of strings, default nil]: purchase IDs. ex: [‘5656565656565656’, ‘4545454545454545’]

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

## Return:

  • generator of CorporatePurchases objects with updated attributes



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 115

def self.query(ids: nil, limit: nil, after: nil, before: nil, merchant_category_types: nil, holder_ids: nil, card_ids: nil,
               status: nil, user: nil)
  after = StarkCore::Utils::Checks.check_date(after)
  before = StarkCore::Utils::Checks.check_date(before)
  StarkBank::Utils::Rest.get_stream(
    ids: ids,
    limit: limit,
    after: after,
    before: before,
    merchant_category_types: merchant_category_types,
    holder_ids: holder_ids,
    card_ids: card_ids,
    status: status,
    user: user,
    **resource
  )
end

.resource ⇒ Object 



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 227

def self.resource
  {
    resource_name: 'CorporatePurchase',
    resource_maker: proc { |json|
      CorporatePurchase.new(
        id: json['id'],
        holder_id: json['holder_id'],
        holder_name: json['holder_name'],
        center_id: json['center_id'],
        card_id: json['card_id'],
        card_ending: json['card_ending'],
        description: json['description'],
        amount: json['amount'],
        tax: json['tax'],
        corporate_amount: json['corporate_amount'],
        corporate_currency_code: json['corporate_currency_code'],
        corporate_currency_symbol: json['corporate_currency_symbol'],
        merchant_amount: json['merchant_amount'],
        merchant_currency_code: json['merchant_currency_code'],
        merchant_currency_symbol: json['merchant_currency_symbol'],
        merchant_category_code: json['merchant_category_code'],
        merchant_category_type: json['merchant_category_type'],
        merchant_country_code: json['merchant_country_code'],
        merchant_name: json['merchant_name'],
        merchant_display_name: json['merchant_display_name'],
        merchant_display_url: json['merchant_display_url'],
        merchant_fee: json['merchant_fee'],
        method_code: json['method_code'],
        tags: json['tags'],
        corporate_transaction_ids: json['corporate_transaction_ids'],
        status: json['status'],
        updated: json['updated'],
        created: json['created'],
      )
    }
  }
end

.response(status:, reason: nil, amount: nil, tags: nil) ⇒ Object

# Helps you respond CorporatePurchase requests

## Parameters (required):

  • status [string]: sub-issuer response to the authorization. ex: ‘approved’ or ‘denied’

## Parameters (conditionally required):

  • reason [string]: denial reason. Options: ‘other’, ‘blocked’, ‘lostCard’, ‘stolenCard’, ‘invalidPin’, ‘invalidCard’, ‘cardExpired’, ‘corporateError’, ‘concurrency’, ‘standInDenial’, ‘subIssuerError’, ‘invalidPurpose’, ‘invalidZipCode’, ‘invalidWalletId’, ‘inconsistentCard’, ‘settlementFailed’, ‘cardRuleMismatch’, ‘invalidExpiration’, ‘prepaidInstallment’, ‘holderRuleMismatch’, ‘insufficientBalance’, ‘tooManyTransactions’, ‘invalidSecurityCode’, ‘invalidPaymentMethod’, ‘confirmationDeadline’, ‘withdrawalAmountLimit’, ‘insufficientCardLimit’, ‘insufficientHolderLimit’

# ## Parameters (optional):

  • amount [integer, default nil]: amount in cents that was authorized. ex: 1234 (= R$ 12.34)

  • tags [list of strings, default nil]: tags to filter retrieved object. ex: [‘tony’, ‘stark’]

## Return:

  • Dumped JSON string that must be returned to us on the CorporatePurchase request



214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/corporate_purchase/corporatepurchase.rb', line 214

def self.response(
  status:, reason: nil, amount: nil, tags: nil
)
  params = {
    'status': status,
    'reason': reason,
    'amount': amount,
    'tags': tags
  }

  params.to_json
end