-
Notifications
You must be signed in to change notification settings - Fork 459
/
error.go
347 lines (313 loc) · 18.4 KB
/
error.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
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
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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
package stripe
import "encoding/json"
// ErrorType is the list of allowed values for the error's type.
type ErrorType string
// List of values that ErrorType can take.
const (
ErrorTypeAPI ErrorType = "api_error"
ErrorTypeCard ErrorType = "card_error"
ErrorTypeIdempotency ErrorType = "idempotency_error"
ErrorTypeInvalidRequest ErrorType = "invalid_request_error"
// error type api_connection_error is deprecated and will be removed in the next version
ErrorTypeAPIConnection ErrorType = "api_connection_error"
// error type authentication_error is deprecated and will be removed in the next version
ErrorTypeAuthentication ErrorType = "authentication_error"
// error type more_permissions_required is deprecated and will be removed in the next version
ErrorTypePermission ErrorType = "more_permissions_required"
// error type rate_limit_error is deprecated and will be removed in the next version
ErrorTypeRateLimit ErrorType = "rate_limit_error"
)
// ErrorCode is the list of allowed values for the error's code.
type ErrorCode string
// DeclineCode is the list of reasons provided by card issuers for decline of payment.
type DeclineCode string
// List of values that ErrorCode can take.
const (
ErrorCodeAccountAlreadyExists ErrorCode = "account_already_exists"
ErrorCodeAccountCountryInvalidAddress ErrorCode = "account_country_invalid_address"
ErrorCodeAccountInvalid ErrorCode = "account_invalid"
ErrorCodeAccountNumberInvalid ErrorCode = "account_number_invalid"
ErrorCodeAlipayUpgradeRequired ErrorCode = "alipay_upgrade_required"
ErrorCodeAmountTooLarge ErrorCode = "amount_too_large"
ErrorCodeAmountTooSmall ErrorCode = "amount_too_small"
ErrorCodeAPIKeyExpired ErrorCode = "api_key_expired"
ErrorCodeAuthenticationRequired ErrorCode = "authentication_required"
ErrorCodeBalanceInsufficient ErrorCode = "balance_insufficient"
ErrorCodeBankAccountDeclined ErrorCode = "bank_account_declined"
ErrorCodeBankAccountExists ErrorCode = "bank_account_exists"
ErrorCodeBankAccountUnusable ErrorCode = "bank_account_unusable"
ErrorCodeBankAccountUnverified ErrorCode = "bank_account_unverified"
ErrorCodeBankAccountVerificationFailed ErrorCode = "bank_account_verification_failed"
ErrorCodeBitcoinUpgradeRequired ErrorCode = "bitcoin_upgrade_required"
ErrorCodeCardDeclinedRateLimitExceeded ErrorCode = "card_decline_rate_limit_exceeded"
ErrorCodeCardDeclined ErrorCode = "card_declined"
ErrorCodeChargeAlreadyCaptured ErrorCode = "charge_already_captured"
ErrorCodeChargeAlreadyRefunded ErrorCode = "charge_already_refunded"
ErrorCodeChargeDisputed ErrorCode = "charge_disputed"
ErrorCodeChargeExceedsSourceLimit ErrorCode = "charge_exceeds_source_limit"
ErrorCodeChargeExpiredForCapture ErrorCode = "charge_expired_for_capture"
ErrorCodeChargeInvalidParameter ErrorCode = "charge_invalid_parameter"
ErrorCodeCountryUnsupported ErrorCode = "country_unsupported"
ErrorCodeCouponExpired ErrorCode = "coupon_expired"
ErrorCodeCustomerMaxPaymentMethods ErrorCode = "customer_max_payment_methods"
ErrorCodeCustomerMaxSubscriptions ErrorCode = "customer_max_subscriptions"
ErrorCodeEmailInvalid ErrorCode = "email_invalid"
ErrorCodeExpiredCard ErrorCode = "expired_card"
ErrorCodeIdempotencyKeyInUse ErrorCode = "idempotency_key_in_use"
ErrorCodeIncorrectAddress ErrorCode = "incorrect_address"
ErrorCodeIncorrectCVC ErrorCode = "incorrect_cvc"
ErrorCodeIncorrectNumber ErrorCode = "incorrect_number"
ErrorCodeIncorrectZip ErrorCode = "incorrect_zip"
ErrorCodeInstantPayoutsUnsupported ErrorCode = "instant_payouts_unsupported"
ErrorCodeInvalidCardType ErrorCode = "invalid_card_type"
ErrorCodeInvalidCharacters ErrorCode = "invalid_characters"
ErrorCodeInvalidChargeAmount ErrorCode = "invalid_charge_amount"
ErrorCodeInvalidCVC ErrorCode = "invalid_cvc"
ErrorCodeInvalidExpiryMonth ErrorCode = "invalid_expiry_month"
ErrorCodeInvalidExpiryYear ErrorCode = "invalid_expiry_year"
ErrorCodeInvalidNumber ErrorCode = "invalid_number"
ErrorCodeInvalidSourceUsage ErrorCode = "invalid_source_usage"
ErrorCodeInvoiceNoCustomerLineItems ErrorCode = "invoice_no_customer_line_items"
ErrorCodeInvoiceNoSubscriptionLineItems ErrorCode = "invoice_no_subscription_line_items"
ErrorCodeInvoiceNotEditable ErrorCode = "invoice_not_editable"
ErrorCodeInvoicePamentIntentRequiresAction ErrorCode = "invoice_payment_intent_requires_action"
ErrorCodeInvoiceUpcomingNone ErrorCode = "invoice_upcoming_none"
ErrorCodeLivemodeMismatch ErrorCode = "livemode_mismatch"
ErrorCodeLockTimeout ErrorCode = "lock_timeout"
ErrorCodeMissing ErrorCode = "missing"
ErrorCodeNotAllowedOnStandardAccount ErrorCode = "not_allowed_on_standard_account"
ErrorCodeOrderCreationFailed ErrorCode = "order_creation_failed"
ErrorCodeOrderRequiredSettings ErrorCode = "order_required_settings"
ErrorCodeOrderStatusInvalid ErrorCode = "order_status_invalid"
ErrorCodeOrderUpstreamTimeout ErrorCode = "order_upstream_timeout"
ErrorCodeOutOfInventory ErrorCode = "out_of_inventory"
ErrorCodeParameterInvalidEmpty ErrorCode = "parameter_invalid_empty"
ErrorCodeParameterInvalidInteger ErrorCode = "parameter_invalid_integer"
ErrorCodeParameterInvalidStringBlank ErrorCode = "parameter_invalid_string_blank"
ErrorCodeParameterInvalidStringEmpty ErrorCode = "parameter_invalid_string_empty"
ErrorCodeParameterMissing ErrorCode = "parameter_missing"
ErrorCodeParameterUnknown ErrorCode = "parameter_unknown"
ErrorCodeParametersExclusive ErrorCode = "parameters_exclusive"
ErrorCodePaymentIntentActionRequired ErrorCode = "payment_intent_action_required"
ErrorCodePaymentIntentAuthenticationFailure ErrorCode = "payment_intent_authentication_failure"
ErrorCodePaymentIntentIncompatiblePaymentMethod ErrorCode = "payment_intent_incompatible_payment_method"
ErrorCodePaymentIntentInvalidParameter ErrorCode = "payment_intent_invalid_parameter"
ErrorCodePaymentIntentPaymentAttemptFailed ErrorCode = "payment_intent_payment_attempt_failed"
ErrorCodePaymentIntentUnexpectedState ErrorCode = "payment_intent_unexpected_state"
ErrorCodePaymentMethodUnactivated ErrorCode = "payment_method_unactivated"
ErrorCodePaymentMethodUnexpectedState ErrorCode = "payment_method_unexpected_state"
ErrorCodePayoutsNotAllowed ErrorCode = "payouts_not_allowed"
ErrorCodePlatformAPIKeyExpired ErrorCode = "platform_api_key_expired"
ErrorCodePostalCodeInvalid ErrorCode = "postal_code_invalid"
ErrorCodeProcessingError ErrorCode = "processing_error"
ErrorCodeProductInactive ErrorCode = "product_inactive"
ErrorCodeRateLimit ErrorCode = "rate_limit"
ErrorCodeResourceAlreadyExists ErrorCode = "resource_already_exists"
ErrorCodeResourceMissing ErrorCode = "resource_missing"
ErrorCodeRoutingNumberInvalid ErrorCode = "routing_number_invalid"
ErrorCodeSecretKeyRequired ErrorCode = "secret_key_required"
ErrorCodeSepaUnsupportedAccount ErrorCode = "sepa_unsupported_account"
ErrorCodeSetupAttemptFailed ErrorCode = "setup_attempt_failed"
ErrorCodeSetupIntentAuthenticationFailure ErrorCode = "setup_intent_authentication_failure"
ErrorCodeSetupIntentInvalidParameter ErrorCode = "setup_intent_invalid_parameter"
ErrorCodeSetupIntentUnexpectedState ErrorCode = "setup_intent_unexpected_state"
ErrorCodeShippingCalculationFailed ErrorCode = "shipping_calculation_failed"
ErrorCodeSkuInactive ErrorCode = "sku_inactive"
ErrorCodeStateUnsupported ErrorCode = "state_unsupported"
ErrorCodeTaxIDInvalid ErrorCode = "tax_id_invalid"
ErrorCodeTaxesCalculationFailed ErrorCode = "taxes_calculation_failed"
ErrorCodeTestmodeChargesOnly ErrorCode = "testmode_charges_only"
ErrorCodeTLSVersionUnsupported ErrorCode = "tls_version_unsupported"
ErrorCodeTokenAlreadyUsed ErrorCode = "token_already_used"
ErrorCodeTokenInUse ErrorCode = "token_in_use"
ErrorCodeTransfersNotAllowed ErrorCode = "transfers_not_allowed"
ErrorCodeUpstreamOrderCreationFailed ErrorCode = "upstream_order_creation_failed"
ErrorCodeURLInvalid ErrorCode = "url_invalid"
// The following error code can be returned though is undocumented
ErrorCodeInvalidSwipeData ErrorCode = "invalid_swipe_data"
)
// List of DeclineCode values.
const (
DeclineCodeAuthenticationRequired DeclineCode = "authentication_required"
DeclineCodeApproveWithID DeclineCode = "approve_with_id"
DeclineCodeCallIssuer DeclineCode = "call_issuer"
DeclineCodeCardNotSupported DeclineCode = "card_not_supported"
DeclineCodeCardVelocityExceeded DeclineCode = "card_velocity_exceeded"
DeclineCodeCurrencyNotSupported DeclineCode = "currency_not_supported"
DeclineCodeDoNotHonor DeclineCode = "do_not_honor"
DeclineCodeDoNotTryAgain DeclineCode = "do_not_try_again"
DeclineCodeDuplicateTransaction DeclineCode = "duplicate_transaction"
DeclineCodeExpiredCard DeclineCode = "expired_card"
DeclineCodeFraudulent DeclineCode = "fraudulent"
DeclineCodeGenericDecline DeclineCode = "generic_decline"
DeclineCodeIncorrectNumber DeclineCode = "incorrect_number"
DeclineCodeIncorrectCVC DeclineCode = "incorrect_cvc"
DeclineCodeIncorrectPIN DeclineCode = "incorrect_pin"
DeclineCodeIncorrectZip DeclineCode = "incorrect_zip"
DeclineCodeInsufficientFunds DeclineCode = "insufficient_funds"
DeclineCodeInvalidAccount DeclineCode = "invalid_account"
DeclineCodeInvalidAmount DeclineCode = "invalid_amount"
DeclineCodeInvalidCVC DeclineCode = "invalid_cvc"
DeclineCodeInvalidExpiryMonth DeclineCode = "invalid_expiry_month"
DeclineCodeInvalidExpiryYear DeclineCode = "invalid_expiry_year"
DeclineCodeInvalidNumber DeclineCode = "invalid_number"
DeclineCodeInvalidPIN DeclineCode = "invalid_pin"
DeclineCodeIssuerNotAvailable DeclineCode = "issuer_not_available"
DeclineCodeLostCard DeclineCode = "lost_card"
DeclineCodeMerchantBlacklist DeclineCode = "merchant_blacklist"
DeclineCodeNewAccountInformationAvailable DeclineCode = "new_account_information_available"
DeclineCodeNoActionTaken DeclineCode = "no_action_taken"
DeclineCodeNotPermitted DeclineCode = "not_permitted"
DeclineCodeOfflinePINRequired DeclineCode = "offline_pin_required"
DeclineCodeOnlineOrOfflinePINRequired DeclineCode = "online_or_offline_pin_required"
DeclineCodePickupCard DeclineCode = "pickup_card"
DeclineCodePINTryExceeded DeclineCode = "pin_try_exceeded"
DeclineCodeProcessingError DeclineCode = "processing_error"
DeclineCodeReenterTransaction DeclineCode = "reenter_transaction"
DeclineCodeRestrictedCard DeclineCode = "restricted_card"
DeclineCodeRevocationOfAllAuthorizations DeclineCode = "revocation_of_all_authorizations"
DeclineCodeRevocationOfAuthorization DeclineCode = "revocation_of_authorization"
DeclineCodeSecurityViolation DeclineCode = "security_violation"
DeclineCodeServiceNotAllowed DeclineCode = "service_not_allowed"
DeclineCodeStolenCard DeclineCode = "stolen_card"
DeclineCodeStopPaymentOrder DeclineCode = "stop_payment_order"
DeclineCodeTestModeDecline DeclineCode = "testmode_decline"
DeclineCodeTransactionNotAllowed DeclineCode = "transaction_not_allowed"
DeclineCodeTryAgainLater DeclineCode = "try_again_later"
DeclineCodeWithdrawalCountLimitExceeded DeclineCode = "withdrawal_count_limit_exceeded"
)
// Error is the response returned when a call is unsuccessful.
// For more details see https://stripe.com/docs/api#errors.
type Error struct {
APIResource
ChargeID string `json:"charge,omitempty"`
Code ErrorCode `json:"code,omitempty"`
DeclineCode DeclineCode `json:"decline_code,omitempty"`
DocURL string `json:"doc_url,omitempty"`
// Err contains an internal error with an additional level of granularity
// that can be used in some cases to get more detailed information about
// what went wrong. For example, Err may hold a CardError that indicates
// exactly what went wrong during charging a card.
Err error `json:"-"`
HTTPStatusCode int `json:"status,omitempty"`
Msg string `json:"message"`
Param string `json:"param,omitempty"`
PaymentIntent *PaymentIntent `json:"payment_intent,omitempty"`
PaymentMethod *PaymentMethod `json:"payment_method,omitempty"`
PaymentMethodType PaymentMethodType `json:"payment_method_type,omitempty"`
RequestID string `json:"request_id,omitempty"`
SetupIntent *SetupIntent `json:"setup_intent,omitempty"`
Source *PaymentSource `json:"source,omitempty"`
Type ErrorType `json:"type"`
// OAuth specific Error properties. Named OAuthError because of name conflict.
OAuthError string `json:"error,omitempty"`
OAuthErrorDescription string `json:"error_description,omitempty"`
}
// Error serializes the error object to JSON and returns it as a string.
func (e *Error) Error() string {
ret, _ := json.Marshal(e)
return string(ret)
}
// Unwrap returns the wrapped typed error.
func (e *Error) Unwrap() error {
return e.Err
}
// APIConnectionError is a failure to connect to the Stripe API.
type APIConnectionError struct {
stripeErr *Error
}
// Error serializes the error object to JSON and returns it as a string.
func (e *APIConnectionError) Error() string {
return e.stripeErr.Error()
}
// APIError is a catch all for any errors not covered by other types (and
// should be extremely uncommon).
type APIError struct {
stripeErr *Error
}
// Error serializes the error object to JSON and returns it as a string.
func (e *APIError) Error() string {
return e.stripeErr.Error()
}
// AuthenticationError is a failure to properly authenticate during a request.
type AuthenticationError struct {
stripeErr *Error
}
// Error serializes the error object to JSON and returns it as a string.
func (e *AuthenticationError) Error() string {
return e.stripeErr.Error()
}
// PermissionError results when you attempt to make an API request
// for which your API key doesn't have the right permissions.
type PermissionError struct {
stripeErr *Error
}
// Error serializes the error object to JSON and returns it as a string.
func (e *PermissionError) Error() string {
return e.stripeErr.Error()
}
// CardError are the most common type of error you should expect to handle.
// They result when the user enters a card that can't be charged for some
// reason.
type CardError struct {
stripeErr *Error
// DeclineCode is a code indicating a card issuer's reason for declining a
// card (if they provided one).
DeclineCode DeclineCode `json:"decline_code,omitempty"`
}
// Error serializes the error object to JSON and returns it as a string.
func (e *CardError) Error() string {
return e.stripeErr.Error()
}
// InvalidRequestError is an error that occurs when a request contains invalid
// parameters.
type InvalidRequestError struct {
stripeErr *Error
}
// Error serializes the error object to JSON and returns it as a string.
func (e *InvalidRequestError) Error() string {
return e.stripeErr.Error()
}
// RateLimitError occurs when the Stripe API is hit to with too many requests
// too quickly and indicates that the current request has been rate limited.
type RateLimitError struct {
stripeErr *Error
}
// Error serializes the error object to JSON and returns it as a string.
func (e *RateLimitError) Error() string {
return e.stripeErr.Error()
}
// IdempotencyError occurs when an Idempotency-Key is re-used on a request
// that does not match the first request's API endpoint and parameters.
type IdempotencyError struct {
stripeErr *Error
}
// Error serializes the error object to JSON and returns it as a string.
func (e *IdempotencyError) Error() string {
return e.stripeErr.Error()
}
// redact returns a copy of the error object with sensitive fields replaced with
// a placeholder value.
func (e *Error) redact() *Error {
// Fast path, since this applies to most cases
if e.PaymentIntent == nil && e.SetupIntent == nil {
return e
}
errCopy := *e
if e.PaymentIntent != nil {
pi := *e.PaymentIntent
errCopy.PaymentIntent = &pi
errCopy.PaymentIntent.ClientSecret = "REDACTED"
}
if e.SetupIntent != nil {
si := *e.SetupIntent
errCopy.SetupIntent = &si
errCopy.SetupIntent.ClientSecret = "REDACTED"
}
return &errCopy
}
// rawError deserializes the outer JSON object returned in an error response
// from the API.
type rawError struct {
Error *Error `json:"error,omitempty"`
}