Skip to content

Commit 98bb99b

Browse files
feat(api): Add merchant location fields to simulator endpoints
1 parent 778fcbb commit 98bb99b

10 files changed

Lines changed: 199 additions & 7 deletions

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 176
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-a6c56df3bc156ac1e6ee5d635c6cd964f0d60836fe17a97deec8af8429bd339c.yml
3-
openapi_spec_hash: c563acd10d96ddabe6c9643b592bd509
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-ce2adff9b644ed4562b5342a4a43d0b40c98d43b4e063b4626f4ca5d342f1b92.yml
3+
openapi_spec_hash: fbc84b866ce96457261ac58b4e75c71d
44
config_hash: 31d71922d7838f34ae0875c9b8026d99

lib/lithic/models/transaction_simulate_authorization_params.rb

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,30 @@ class TransactionSimulateAuthorizationParams < Lithic::Internal::Type::BaseModel
3737
# @return [String, nil]
3838
optional :mcc, String
3939

40+
# @!attribute merchant_acceptor_city
41+
# Merchant acceptor city
42+
#
43+
# @return [String, nil]
44+
optional :merchant_acceptor_city, String
45+
46+
# @!attribute merchant_acceptor_country
47+
# Merchant acceptor country code (ISO 3166-1 alpha-3)
48+
#
49+
# @return [String, nil]
50+
optional :merchant_acceptor_country, String
51+
4052
# @!attribute merchant_acceptor_id
4153
# Unique identifier to identify the payment card acceptor.
4254
#
4355
# @return [String, nil]
4456
optional :merchant_acceptor_id, String
4557

58+
# @!attribute merchant_acceptor_state
59+
# Merchant acceptor state/province (ISO 3166-2 subdivision code)
60+
#
61+
# @return [String, nil]
62+
optional :merchant_acceptor_state, String
63+
4664
# @!attribute merchant_amount
4765
# Amount of the transaction to be simulated in currency specified in
4866
# merchant_currency, including any acquirer fees.
@@ -92,7 +110,7 @@ class TransactionSimulateAuthorizationParams < Lithic::Internal::Type::BaseModel
92110
# @return [Symbol, Lithic::Models::TransactionSimulateAuthorizationParams::Status, nil]
93111
optional :status, enum: -> { Lithic::TransactionSimulateAuthorizationParams::Status }
94112

95-
# @!method initialize(amount:, descriptor:, pan:, mcc: nil, merchant_acceptor_id: nil, merchant_amount: nil, merchant_currency: nil, partial_approval_capable: nil, pin: nil, status: nil, request_options: {})
113+
# @!method initialize(amount:, descriptor:, pan:, mcc: nil, merchant_acceptor_city: nil, merchant_acceptor_country: nil, merchant_acceptor_id: nil, merchant_acceptor_state: nil, merchant_amount: nil, merchant_currency: nil, partial_approval_capable: nil, pin: nil, status: nil, request_options: {})
96114
# Some parameter documentations has been truncated, see
97115
# {Lithic::Models::TransactionSimulateAuthorizationParams} for more details.
98116
#
@@ -104,8 +122,14 @@ class TransactionSimulateAuthorizationParams < Lithic::Internal::Type::BaseModel
104122
#
105123
# @param mcc [String] Merchant category code for the transaction to be simulated. A four-digit number
106124
#
125+
# @param merchant_acceptor_city [String] Merchant acceptor city
126+
#
127+
# @param merchant_acceptor_country [String] Merchant acceptor country code (ISO 3166-1 alpha-3)
128+
#
107129
# @param merchant_acceptor_id [String] Unique identifier to identify the payment card acceptor.
108130
#
131+
# @param merchant_acceptor_state [String] Merchant acceptor state/province (ISO 3166-2 subdivision code)
132+
#
109133
# @param merchant_amount [Integer] Amount of the transaction to be simulated in currency specified in merchant_curr
110134
#
111135
# @param merchant_currency [String] 3-character alphabetic ISO 4217 currency code. Note: Simulator only accepts USD,

lib/lithic/models/transaction_simulate_credit_authorization_advice_params.rb

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,31 @@ class TransactionSimulateCreditAuthorizationAdviceParams < Lithic::Internal::Typ
3535
# @return [String, nil]
3636
optional :mcc, String
3737

38+
# @!attribute merchant_acceptor_city
39+
# Merchant acceptor city
40+
#
41+
# @return [String, nil]
42+
optional :merchant_acceptor_city, String
43+
44+
# @!attribute merchant_acceptor_country
45+
# Merchant acceptor country code (ISO 3166-1 alpha-3)
46+
#
47+
# @return [String, nil]
48+
optional :merchant_acceptor_country, String
49+
3850
# @!attribute merchant_acceptor_id
3951
# Unique identifier to identify the payment card acceptor.
4052
#
4153
# @return [String, nil]
4254
optional :merchant_acceptor_id, String
4355

44-
# @!method initialize(amount:, descriptor:, pan:, mcc: nil, merchant_acceptor_id: nil, request_options: {})
56+
# @!attribute merchant_acceptor_state
57+
# Merchant acceptor state/province (ISO 3166-2 subdivision code)
58+
#
59+
# @return [String, nil]
60+
optional :merchant_acceptor_state, String
61+
62+
# @!method initialize(amount:, descriptor:, pan:, mcc: nil, merchant_acceptor_city: nil, merchant_acceptor_country: nil, merchant_acceptor_id: nil, merchant_acceptor_state: nil, request_options: {})
4563
# Some parameter documentations has been truncated, see
4664
# {Lithic::Models::TransactionSimulateCreditAuthorizationAdviceParams} for more
4765
# details.
@@ -54,8 +72,14 @@ class TransactionSimulateCreditAuthorizationAdviceParams < Lithic::Internal::Typ
5472
#
5573
# @param mcc [String] Merchant category code for the transaction to be simulated. A four-digit number
5674
#
75+
# @param merchant_acceptor_city [String] Merchant acceptor city
76+
#
77+
# @param merchant_acceptor_country [String] Merchant acceptor country code (ISO 3166-1 alpha-3)
78+
#
5779
# @param merchant_acceptor_id [String] Unique identifier to identify the payment card acceptor.
5880
#
81+
# @param merchant_acceptor_state [String] Merchant acceptor state/province (ISO 3166-2 subdivision code)
82+
#
5983
# @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
6084
end
6185
end

lib/lithic/resources/transactions.rb

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ def expire_authorization(transaction_token, params = {})
105105
# [update account](https://docs.lithic.com/reference/patchaccountbytoken)
106106
# endpoint.
107107
#
108-
# @overload simulate_authorization(amount:, descriptor:, pan:, mcc: nil, merchant_acceptor_id: nil, merchant_amount: nil, merchant_currency: nil, partial_approval_capable: nil, pin: nil, status: nil, request_options: {})
108+
# @overload simulate_authorization(amount:, descriptor:, pan:, mcc: nil, merchant_acceptor_city: nil, merchant_acceptor_country: nil, merchant_acceptor_id: nil, merchant_acceptor_state: nil, merchant_amount: nil, merchant_currency: nil, partial_approval_capable: nil, pin: nil, status: nil, request_options: {})
109109
#
110110
# @param amount [Integer] Amount (in cents) to authorize. For credit authorizations and financial credit a
111111
#
@@ -115,8 +115,14 @@ def expire_authorization(transaction_token, params = {})
115115
#
116116
# @param mcc [String] Merchant category code for the transaction to be simulated. A four-digit number
117117
#
118+
# @param merchant_acceptor_city [String] Merchant acceptor city
119+
#
120+
# @param merchant_acceptor_country [String] Merchant acceptor country code (ISO 3166-1 alpha-3)
121+
#
118122
# @param merchant_acceptor_id [String] Unique identifier to identify the payment card acceptor.
119123
#
124+
# @param merchant_acceptor_state [String] Merchant acceptor state/province (ISO 3166-2 subdivision code)
125+
#
120126
# @param merchant_amount [Integer] Amount of the transaction to be simulated in currency specified in merchant_curr
121127
#
122128
# @param merchant_currency [String] 3-character alphabetic ISO 4217 currency code. Note: Simulator only accepts USD,
@@ -211,7 +217,7 @@ def simulate_clearing(params)
211217
# Simulates a credit authorization advice from the card network. This message
212218
# indicates that the network approved a credit authorization on your behalf.
213219
#
214-
# @overload simulate_credit_authorization_advice(amount:, descriptor:, pan:, mcc: nil, merchant_acceptor_id: nil, request_options: {})
220+
# @overload simulate_credit_authorization_advice(amount:, descriptor:, pan:, mcc: nil, merchant_acceptor_city: nil, merchant_acceptor_country: nil, merchant_acceptor_id: nil, merchant_acceptor_state: nil, request_options: {})
215221
#
216222
# @param amount [Integer] Amount (in cents). Any value entered will be converted into a negative amount in
217223
#
@@ -221,8 +227,14 @@ def simulate_clearing(params)
221227
#
222228
# @param mcc [String] Merchant category code for the transaction to be simulated. A four-digit number
223229
#
230+
# @param merchant_acceptor_city [String] Merchant acceptor city
231+
#
232+
# @param merchant_acceptor_country [String] Merchant acceptor country code (ISO 3166-1 alpha-3)
233+
#
224234
# @param merchant_acceptor_id [String] Unique identifier to identify the payment card acceptor.
225235
#
236+
# @param merchant_acceptor_state [String] Merchant acceptor state/province (ISO 3166-2 subdivision code)
237+
#
226238
# @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
227239
#
228240
# @return [Lithic::Models::TransactionSimulateCreditAuthorizationAdviceResponse]

rbi/lithic/models/transaction_simulate_authorization_params.rbi

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,34 @@ module Lithic
3939
sig { params(mcc: String).void }
4040
attr_writer :mcc
4141

42+
# Merchant acceptor city
43+
sig { returns(T.nilable(String)) }
44+
attr_reader :merchant_acceptor_city
45+
46+
sig { params(merchant_acceptor_city: String).void }
47+
attr_writer :merchant_acceptor_city
48+
49+
# Merchant acceptor country code (ISO 3166-1 alpha-3)
50+
sig { returns(T.nilable(String)) }
51+
attr_reader :merchant_acceptor_country
52+
53+
sig { params(merchant_acceptor_country: String).void }
54+
attr_writer :merchant_acceptor_country
55+
4256
# Unique identifier to identify the payment card acceptor.
4357
sig { returns(T.nilable(String)) }
4458
attr_reader :merchant_acceptor_id
4559

4660
sig { params(merchant_acceptor_id: String).void }
4761
attr_writer :merchant_acceptor_id
4862

63+
# Merchant acceptor state/province (ISO 3166-2 subdivision code)
64+
sig { returns(T.nilable(String)) }
65+
attr_reader :merchant_acceptor_state
66+
67+
sig { params(merchant_acceptor_state: String).void }
68+
attr_writer :merchant_acceptor_state
69+
4970
# Amount of the transaction to be simulated in currency specified in
5071
# merchant_currency, including any acquirer fees.
5172
sig { returns(T.nilable(Integer)) }
@@ -117,7 +138,10 @@ module Lithic
117138
descriptor: String,
118139
pan: String,
119140
mcc: String,
141+
merchant_acceptor_city: String,
142+
merchant_acceptor_country: String,
120143
merchant_acceptor_id: String,
144+
merchant_acceptor_state: String,
121145
merchant_amount: Integer,
122146
merchant_currency: String,
123147
partial_approval_capable: T::Boolean,
@@ -142,8 +166,14 @@ module Lithic
142166
# listed in ISO 18245. Supported merchant category codes can be found
143167
# [here](https://docs.lithic.com/docs/transactions#merchant-category-codes-mccs).
144168
mcc: nil,
169+
# Merchant acceptor city
170+
merchant_acceptor_city: nil,
171+
# Merchant acceptor country code (ISO 3166-1 alpha-3)
172+
merchant_acceptor_country: nil,
145173
# Unique identifier to identify the payment card acceptor.
146174
merchant_acceptor_id: nil,
175+
# Merchant acceptor state/province (ISO 3166-2 subdivision code)
176+
merchant_acceptor_state: nil,
147177
# Amount of the transaction to be simulated in currency specified in
148178
# merchant_currency, including any acquirer fees.
149179
merchant_amount: nil,
@@ -184,7 +214,10 @@ module Lithic
184214
descriptor: String,
185215
pan: String,
186216
mcc: String,
217+
merchant_acceptor_city: String,
218+
merchant_acceptor_country: String,
187219
merchant_acceptor_id: String,
220+
merchant_acceptor_state: String,
188221
merchant_amount: Integer,
189222
merchant_currency: String,
190223
partial_approval_capable: T::Boolean,

rbi/lithic/models/transaction_simulate_credit_authorization_advice_params.rbi

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,20 +37,44 @@ module Lithic
3737
sig { params(mcc: String).void }
3838
attr_writer :mcc
3939

40+
# Merchant acceptor city
41+
sig { returns(T.nilable(String)) }
42+
attr_reader :merchant_acceptor_city
43+
44+
sig { params(merchant_acceptor_city: String).void }
45+
attr_writer :merchant_acceptor_city
46+
47+
# Merchant acceptor country code (ISO 3166-1 alpha-3)
48+
sig { returns(T.nilable(String)) }
49+
attr_reader :merchant_acceptor_country
50+
51+
sig { params(merchant_acceptor_country: String).void }
52+
attr_writer :merchant_acceptor_country
53+
4054
# Unique identifier to identify the payment card acceptor.
4155
sig { returns(T.nilable(String)) }
4256
attr_reader :merchant_acceptor_id
4357

4458
sig { params(merchant_acceptor_id: String).void }
4559
attr_writer :merchant_acceptor_id
4660

61+
# Merchant acceptor state/province (ISO 3166-2 subdivision code)
62+
sig { returns(T.nilable(String)) }
63+
attr_reader :merchant_acceptor_state
64+
65+
sig { params(merchant_acceptor_state: String).void }
66+
attr_writer :merchant_acceptor_state
67+
4768
sig do
4869
params(
4970
amount: Integer,
5071
descriptor: String,
5172
pan: String,
5273
mcc: String,
74+
merchant_acceptor_city: String,
75+
merchant_acceptor_country: String,
5376
merchant_acceptor_id: String,
77+
merchant_acceptor_state: String,
5478
request_options: Lithic::RequestOptions::OrHash
5579
).returns(T.attached_class)
5680
end
@@ -67,8 +91,14 @@ module Lithic
6791
# listed in ISO 18245. Supported merchant category codes can be found
6892
# [here](https://docs.lithic.com/docs/transactions#merchant-category-codes-mccs).
6993
mcc: nil,
94+
# Merchant acceptor city
95+
merchant_acceptor_city: nil,
96+
# Merchant acceptor country code (ISO 3166-1 alpha-3)
97+
merchant_acceptor_country: nil,
7098
# Unique identifier to identify the payment card acceptor.
7199
merchant_acceptor_id: nil,
100+
# Merchant acceptor state/province (ISO 3166-2 subdivision code)
101+
merchant_acceptor_state: nil,
72102
request_options: {}
73103
)
74104
end
@@ -80,7 +110,10 @@ module Lithic
80110
descriptor: String,
81111
pan: String,
82112
mcc: String,
113+
merchant_acceptor_city: String,
114+
merchant_acceptor_country: String,
83115
merchant_acceptor_id: String,
116+
merchant_acceptor_state: String,
84117
request_options: Lithic::RequestOptions
85118
}
86119
)

rbi/lithic/resources/transactions.rbi

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,10 @@ module Lithic
9696
descriptor: String,
9797
pan: String,
9898
mcc: String,
99+
merchant_acceptor_city: String,
100+
merchant_acceptor_country: String,
99101
merchant_acceptor_id: String,
102+
merchant_acceptor_state: String,
100103
merchant_amount: Integer,
101104
merchant_currency: String,
102105
partial_approval_capable: T::Boolean,
@@ -121,8 +124,14 @@ module Lithic
121124
# listed in ISO 18245. Supported merchant category codes can be found
122125
# [here](https://docs.lithic.com/docs/transactions#merchant-category-codes-mccs).
123126
mcc: nil,
127+
# Merchant acceptor city
128+
merchant_acceptor_city: nil,
129+
# Merchant acceptor country code (ISO 3166-1 alpha-3)
130+
merchant_acceptor_country: nil,
124131
# Unique identifier to identify the payment card acceptor.
125132
merchant_acceptor_id: nil,
133+
# Merchant acceptor state/province (ISO 3166-2 subdivision code)
134+
merchant_acceptor_state: nil,
126135
# Amount of the transaction to be simulated in currency specified in
127136
# merchant_currency, including any acquirer fees.
128137
merchant_amount: nil,
@@ -216,7 +225,10 @@ module Lithic
216225
descriptor: String,
217226
pan: String,
218227
mcc: String,
228+
merchant_acceptor_city: String,
229+
merchant_acceptor_country: String,
219230
merchant_acceptor_id: String,
231+
merchant_acceptor_state: String,
220232
request_options: Lithic::RequestOptions::OrHash
221233
).returns(
222234
Lithic::Models::TransactionSimulateCreditAuthorizationAdviceResponse
@@ -235,8 +247,14 @@ module Lithic
235247
# listed in ISO 18245. Supported merchant category codes can be found
236248
# [here](https://docs.lithic.com/docs/transactions#merchant-category-codes-mccs).
237249
mcc: nil,
250+
# Merchant acceptor city
251+
merchant_acceptor_city: nil,
252+
# Merchant acceptor country code (ISO 3166-1 alpha-3)
253+
merchant_acceptor_country: nil,
238254
# Unique identifier to identify the payment card acceptor.
239255
merchant_acceptor_id: nil,
256+
# Merchant acceptor state/province (ISO 3166-2 subdivision code)
257+
merchant_acceptor_state: nil,
240258
request_options: {}
241259
)
242260
end

0 commit comments

Comments
 (0)