-
Notifications
You must be signed in to change notification settings - Fork 448
/
mandate.go
183 lines (162 loc) · 8.17 KB
/
mandate.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
//
//
// File generated from our OpenAPI spec
//
//
package stripe
import "encoding/json"
// The type of customer acceptance information included with the Mandate. One of `online` or `offline`.
type MandateCustomerAcceptanceType string
// List of values that MandateCustomerAcceptanceType can take
const (
MandateCustomerAcceptanceTypeOffline MandateCustomerAcceptanceType = "offline"
MandateCustomerAcceptanceTypeOnline MandateCustomerAcceptanceType = "online"
)
// List of Stripe products where this mandate can be selected automatically.
type MandatePaymentMethodDetailsACSSDebitDefaultFor string
// List of values that MandatePaymentMethodDetailsACSSDebitDefaultFor can take
const (
MandatePaymentMethodDetailsACSSDebitDefaultForInvoice MandatePaymentMethodDetailsACSSDebitDefaultFor = "invoice"
MandatePaymentMethodDetailsACSSDebitDefaultForSubscription MandatePaymentMethodDetailsACSSDebitDefaultFor = "subscription"
)
// Payment schedule for the mandate.
type MandatePaymentMethodDetailsACSSDebitPaymentSchedule string
// List of values that MandatePaymentMethodDetailsACSSDebitPaymentSchedule can take
const (
MandatePaymentMethodDetailsACSSDebitPaymentScheduleCombined MandatePaymentMethodDetailsACSSDebitPaymentSchedule = "combined"
MandatePaymentMethodDetailsACSSDebitPaymentScheduleInterval MandatePaymentMethodDetailsACSSDebitPaymentSchedule = "interval"
MandatePaymentMethodDetailsACSSDebitPaymentScheduleSporadic MandatePaymentMethodDetailsACSSDebitPaymentSchedule = "sporadic"
)
// Transaction type of the mandate.
type MandatePaymentMethodDetailsACSSDebitTransactionType string
// List of values that MandatePaymentMethodDetailsACSSDebitTransactionType can take
const (
MandatePaymentMethodDetailsACSSDebitTransactionTypeBusiness MandatePaymentMethodDetailsACSSDebitTransactionType = "business"
MandatePaymentMethodDetailsACSSDebitTransactionTypePersonal MandatePaymentMethodDetailsACSSDebitTransactionType = "personal"
)
// The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`.
type MandatePaymentMethodDetailsBACSDebitNetworkStatus string
// List of values that MandatePaymentMethodDetailsBACSDebitNetworkStatus can take
const (
MandatePaymentMethodDetailsBACSDebitNetworkStatusAccepted MandatePaymentMethodDetailsBACSDebitNetworkStatus = "accepted"
MandatePaymentMethodDetailsBACSDebitNetworkStatusPending MandatePaymentMethodDetailsBACSDebitNetworkStatus = "pending"
MandatePaymentMethodDetailsBACSDebitNetworkStatusRefused MandatePaymentMethodDetailsBACSDebitNetworkStatus = "refused"
MandatePaymentMethodDetailsBACSDebitNetworkStatusRevoked MandatePaymentMethodDetailsBACSDebitNetworkStatus = "revoked"
)
// The status of the mandate, which indicates whether it can be used to initiate a payment.
type MandateStatus string
// List of values that MandateStatus can take
const (
MandateStatusActive MandateStatus = "active"
MandateStatusInactive MandateStatus = "inactive"
MandateStatusPending MandateStatus = "pending"
)
// The type of the mandate.
type MandateType string
// List of values that MandateType can take
const (
MandateTypeMultiUse MandateType = "multi_use"
MandateTypeSingleUse MandateType = "single_use"
)
// Retrieves a Mandate object.
type MandateParams struct {
Params `form:"*"`
}
type MandateCustomerAcceptanceOffline struct{}
type MandateCustomerAcceptanceOnline struct {
// The IP address from which the Mandate was accepted by the customer.
IPAddress string `json:"ip_address"`
// The user agent of the browser from which the Mandate was accepted by the customer.
UserAgent string `json:"user_agent"`
}
type MandateCustomerAcceptance struct {
// The time at which the customer accepted the Mandate.
AcceptedAt int64 `json:"accepted_at"`
Offline *MandateCustomerAcceptanceOffline `json:"offline"`
Online *MandateCustomerAcceptanceOnline `json:"online"`
// The type of customer acceptance information included with the Mandate. One of `online` or `offline`.
Type MandateCustomerAcceptanceType `json:"type"`
}
type MandateMultiUse struct{}
type MandatePaymentMethodDetailsACSSDebit struct {
// List of Stripe products where this mandate can be selected automatically.
DefaultFor []MandatePaymentMethodDetailsACSSDebitDefaultFor `json:"default_for"`
// Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
IntervalDescription string `json:"interval_description"`
// Payment schedule for the mandate.
PaymentSchedule MandatePaymentMethodDetailsACSSDebitPaymentSchedule `json:"payment_schedule"`
// Transaction type of the mandate.
TransactionType MandatePaymentMethodDetailsACSSDebitTransactionType `json:"transaction_type"`
}
type MandatePaymentMethodDetailsAUBECSDebit struct {
// The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively.
URL string `json:"url"`
}
type MandatePaymentMethodDetailsBACSDebit struct {
// The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`.
NetworkStatus MandatePaymentMethodDetailsBACSDebitNetworkStatus `json:"network_status"`
// The unique reference identifying the mandate on the Bacs network.
Reference string `json:"reference"`
// The URL that will contain the mandate that the customer has signed.
URL string `json:"url"`
}
type MandatePaymentMethodDetailsCard struct{}
type MandatePaymentMethodDetailsSepaDebit struct {
// The unique reference of the mandate.
Reference string `json:"reference"`
// The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively.
URL string `json:"url"`
}
type MandatePaymentMethodDetailsUSBankAccount struct{}
type MandatePaymentMethodDetails struct {
ACSSDebit *MandatePaymentMethodDetailsACSSDebit `json:"acss_debit"`
AUBECSDebit *MandatePaymentMethodDetailsAUBECSDebit `json:"au_becs_debit"`
BACSDebit *MandatePaymentMethodDetailsBACSDebit `json:"bacs_debit"`
Card *MandatePaymentMethodDetailsCard `json:"card"`
SepaDebit *MandatePaymentMethodDetailsSepaDebit `json:"sepa_debit"`
// The type of the payment method associated with this mandate. An additional hash is included on `payment_method_details` with a name matching this value. It contains mandate information specific to the payment method.
Type PaymentMethodType `json:"type"`
USBankAccount *MandatePaymentMethodDetailsUSBankAccount `json:"us_bank_account"`
}
type MandateSingleUse struct {
// On a single use mandate, the amount of the payment.
Amount int64 `json:"amount"`
// On a single use mandate, the currency of the payment.
Currency Currency `json:"currency"`
}
// A Mandate is a record of the permission a customer has given you to debit their payment method.
type Mandate struct {
APIResource
CustomerAcceptance *MandateCustomerAcceptance `json:"customer_acceptance"`
// Unique identifier for the object.
ID string `json:"id"`
// Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
Livemode bool `json:"livemode"`
MultiUse *MandateMultiUse `json:"multi_use"`
// String representing the object's type. Objects of the same type share the same value.
Object string `json:"object"`
// ID of the payment method associated with this mandate.
PaymentMethod *PaymentMethod `json:"payment_method"`
PaymentMethodDetails *MandatePaymentMethodDetails `json:"payment_method_details"`
SingleUse *MandateSingleUse `json:"single_use"`
// The status of the mandate, which indicates whether it can be used to initiate a payment.
Status MandateStatus `json:"status"`
// The type of the mandate.
Type MandateType `json:"type"`
}
// UnmarshalJSON handles deserialization of a Mandate.
// This custom unmarshaling is needed because the resulting
// property may be an id or the full struct if it was expanded.
func (m *Mandate) UnmarshalJSON(data []byte) error {
if id, ok := ParseID(data); ok {
m.ID = id
return nil
}
type mandate Mandate
var v mandate
if err := json.Unmarshal(data, &v); err != nil {
return err
}
*m = Mandate(v)
return nil
}