-
Notifications
You must be signed in to change notification settings - Fork 4
/
index.js
392 lines (378 loc) · 13.1 KB
/
index.js
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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
const Stripe = require("stripe")
module.exports = (stripeSecretKey) => {
const stripe = Stripe(stripeSecretKey)
return {
/**
* Create a Customer on Stripe
* @param {string} [email=null]
* @returns {Promise}
*/
async customerCreate(email = null) {
try {
return await stripe.customers.create({ email })
} catch (err) {
// istanbul ignore next
throw err
}
},
/**
* Delete a Customer on Stripe
* @param {string} stripeCustomerId Customer ID to delete (begins with "cus_")
* @returns {Promise}
*/
async customerDelete(stripeCustomerId) {
try {
return await stripe.customers.del(stripeCustomerId)
} catch (err) {
// istanbul ignore next
throw err
}
},
/**
* Create a Vendor (Custom Account on Stripe)
* @param {string} [email=null]
* @param {string} [country=US]
* @returns {Promise}
*/
async vendorCreate(email = null, country = "US") {
try {
return await stripe.accounts.create({
country,
business_type: "individual",
requested_capabilities: ["transfers"],
type: "custom",
email,
})
} catch (err) {
// istanbul ignore next
throw err
}
},
/**
* Delete a Vendor (Custom Account on Stripe)
* @param {string} stripeAccountId Vendor ID (Custom Account on Stripe) to delete (begins with "acct_")
* @returns {Promise}
*/
async vendorDelete(stripeAccountId) {
try {
return await stripe.accounts.del(stripeAccountId)
} catch (err) {
// istanbul ignore next
throw err
}
},
/**
* Fetch all the Cards (or other sources) associated with the Customer with the provided id. The default card is marked as such.
* @param {string} stripeCustomerId Customer Id (begins with "cus_")
* @returns {Promise}
*/
async fetchCustomerCards(stripeCustomerId) {
try {
const result = await Promise.all([
await stripe.customers.listSources(stripeCustomerId),
await stripe.customers.retrieve(stripeCustomerId)
])
const { data } = result[0]
const { default_source } = result[1] // eslint-disable-line camelcase
return data.map(card => Object.assign(card, {
isDefault: (card.id === default_source) // eslint-disable-line camelcase
}))
} catch (err) {
// istanbul ignore next
throw err
}
},
/**
* Add a Card to a Customer
* @param {string} stripeCustomerId Id of the Customer to whom the Card is to be added (begins with "cus_")
* @param {string} stripeToken The token representing the Card to add, genetrated client-side using Stripe.js, etc.
* @returns {Promise}
*/
async addCustomerCard(stripeCustomerId, stripeToken) {
try {
return await stripe.customers.createSource(stripeCustomerId, {
source: stripeToken
})
} catch (err) {
// istanbul ignore next
throw err
}
},
/**
* Delete a Customer's Card
* @param {string} stripeCustomerId Id of the Customer for whom the Card is to be deleted (begins with "cus_")
* @param {string} cardId Id of the Card to be deleted
* @returns {Promise}
*/
async deleteCustomerCard(stripeCustomerId, cardId) {
try {
return await stripe
.customers
.deleteSource(stripeCustomerId, cardId)
} catch (err) {
// istanbul ignore next
throw err
}
},
/**
* Get a Customer's default Card. Note that, this info is already available implicitly from `fetchCustomerCards()`
* @param {string} stripeCustomerId Customer Id (begins with "cus_")
* @returns {Promise}
*/
async getDefaultCustomerCard(stripeCustomerId) {
try {
const {
default_source // eslint-disable-line camelcase
} = await stripe.customers.retrieve(stripeCustomerId)
return default_source // eslint-disable-line camelcase
} catch (err) {
// istanbul ignore next
throw err
}
},
/**
* Set an existing Customer Card as the default payment source
* @param {string} stripeCustomerId Customer Id (begins with "cus_")
* @param {string} stripeCardId The id of the Card to be set as default. Must be one of the Customer's existing Cards.
* @returns {Promise}
*/
async setDefaultCustomerCard(stripeCustomerId, stripeCardId) {
try {
const {
default_source // eslint-disable-line camelcase
} = await stripe.customers.update(stripeCustomerId, { // eslint-disable-line camelcase
default_source: stripeCardId
})
return default_source // eslint-disable-line camelcase
} catch (err) {
// istanbul ignore next
throw err
}
},
/**
* Set the default Bank A/c for a Vendor (Custom Account on Stripe)
* @param {string} stripeAccountId Vendor Id (begins with "acct_")
* @param {object} _ The Bank A/c details
* @param {string} _.routingNo
* @param {string} _.accountNo
* @param {string} [_.accountHolderName=null]
* @param {string} [_.country=US]
* @param {string} [_.currency=usd]
* @returns {Promise}
*/
async setVendorBankAccount(stripeAccountId, {
routingNo,
accountNo,
accountHolderName = null,
country = "US",
currency = "usd"
}) {
try {
const accountObj = {
object: "bank_account",
country,
currency,
account_number: accountNo,
routing_number: routingNo,
}
if (accountHolderName !== null) {
accountObj.account_holder_name = accountHolderName
}
return await stripe.accounts.update(stripeAccountId, {
external_account: accountObj
})
} catch (err) {
// istanbul ignore next
throw err
}
},
/**
* Update KYC details for a Vendor (Stripe Custom Account). These are mandatory to be able to receive payments and payouts.
* @param {string} stripeAccountId Vendor Id (begins with "acct_")
* @param {object} _ The KYC details
* @param {object} _.address Address details
* @param {string} _.address.city City
* @param {string} _.address.line1 Address Line 1
* @param {string} _.address.line2 Address Line 2
* @param {string} _.address.postal_code ZIP/Postal Code
* @param {string} _.address.state State/County/Province/Region
* @param {string} _.address.country 2-letter Country Code
* @param {object} _.dob Date of Birth
* @param {string} _.dob.day Day of Birth
* @param {string} _.dob.month Month of Birth
* @param {string} _.dob.year Year of Birth
* @param {object} _.name Name
* @param {string} _.name.first First Name
* @param {string} _.name.last Last Name
* @param {string} _.email Email Id
* @param {string} _.phone Phone Number
* @param {string} _.businessUrl Business url
* @param {string} _.personalIdNumber Personal ID Number (For some Non US Countries)
* @param {string} _.ssnLastFour Last 4 digits of the SSN
* @param {string} _.mcc Stripe Merchant Category Code (Ref: https://stripe.com/docs/connect/setting-mcc)
* @returns {Promise}
*/
async vendorKyc(stripeAccountId, {
address = {},
dob = {},
name = {},
email = null,
phone = null,
businessUrl = null,
ssnLastFour = null,
personalIdNumber = null,
mcc = null
}) {
try {
const entityObj = {
individual: {
address,
dob,
first_name: name.first,
last_name: name.last,
id_number: personalIdNumber,
ssn_last_4: ssnLastFour,
email,
phone
},
business_type: "individual",
business_profile: {
mcc,
url: businessUrl
}
}
if (ssnLastFour !== null && personalIdNumber !== null) {
entityObj.individual.ssn_last_4 = ssnLastFour
entityObj.individual.id_number = personalIdNumber
}
return await stripe.accounts.update(stripeAccountId, entityObj)
} catch (err) {
// istanbul ignore next
throw err
}
},
/**
* ToS acceptance of a Vendor (Stripe Custom Account)
* @param {string} stripeAccountId Vendor Id (begins with "acct_")
* @param {object} _ ToS Acceptance details
* @param {number} _.tosAcceptanceDate Date (in UNIX timestamp format) of ToS acceptance
* @param {string} _.tosAcceptanceIp IP address from where the ToS was accepted
* @param {string} [_.tosUserAgent=null] User Agent string of the browser using which the ToS was accepted
* @returns {Promise}
*/
async vendorAcceptTos(stripeAccountId, {
tosAcceptanceDate,
tosAcceptanceIp,
tosUserAgent = null
}) {
try {
const tosObj = {
date: tosAcceptanceDate,
ip: tosAcceptanceIp,
}
if (tosUserAgent !== null) tosObj.user_agent = tosUserAgent
return await stripe.accounts.update(stripeAccountId, {
tos_acceptance: tosObj
})
} catch (err) {
// istanbul ignore next
throw err
}
},
/**
* Initiate a Payment (Stripe Charge creation)
* @param {object} _ Payment (Stripe Charge) parameters
* @param {boolean} [_.capture=false] Whether to capture this charge later or immediately. By default, it is set to false, signifying later capture. Note that such charges need to be captured manually within 7 days, beyond which it is automatically reveresed/refunded by Stripe.
* @param {string} _.customer Id of the Customer (Stripe Customer) making the payment (begins with "cus_")
* @param {string} _.vendor Id of the Vendor (Stripe Custom Account) to receive the payment (begins with "acct_")
* @param {number} _.amount Amount to deduct from Customer
* @param {number} _.vendorAmount Amount payable to the Vendor. Must be less than or equal to `amount`. Ideally, the difference between `amount` & `vendorAmount`, minus the Stripe fees, is what the Marketplace retains as profit.
* @param {string} _.currency Currency code
* @param {string} [_.receiptEmail=null] Email to mail the receipt from Stripe
* @param {string} [_.description] Optional description
* @param {string} [_.statementDescriptor] Text appearing on Bank/Card statements
* @returns {Promise}
*/
async initiatePayment({
customer,
vendor,
amount,
vendorAmount,
currency,
receiptEmail = null,
description = null,
statementDescriptor = null,
capture = false
}) {
try {
const opts = {
capture,
customer,
amount: amount * 100, // convert to cents from dollar
currency,
description,
destination: {
amount: vendorAmount * 100,
account: vendor,
}
}
if (receiptEmail !== null) opts.receipt_email = receiptEmail
if (statementDescriptor !== null) opts.statement_descriptor = statementDescriptor
return await stripe.charges.create(opts)
} catch (err) {
// istanbul ignore next
throw err
}
},
/**
* Capture an existing Payment (Stripe Charge)
* @param {string} transactionId Id of the Stripe Charge to capture (begins with "ch_")
* @param {number} [vendorAmount=null] Optionally update the amount payable to Vendor. If not mentioned, the amount in original charge is used.
* @param {string} [statementDescriptor] Text appearing on Bank/Card statements (overrides the one mentioned in original charge)
* @returns {Promise}
*/
async capturePayment(
transactionId,
vendorAmount = null,
statementDescriptor = null
) {
try {
const objToCapture = {}
if (statementDescriptor !== null) {
objToCapture.statement_descriptor = statementDescriptor
}
if (vendorAmount !== null) { // Update amount payable to Vendor; otherwise send the initiated amount
objToCapture.destination = {
amount: vendorAmount * 100, // convert to cents from dollar
}
}
return await stripe.charges.capture(transactionId, objToCapture)
} catch (err) {
// istanbul ignore next
throw err
}
},
/**
* Refund a previously captured (but unrefunded) Charge
* @param {string} transactionId The Stripe Charge Id to Refund
* @param {string} amount Amount to refund
* @param {string} [reason=null] Reason for refund
* @returns {Promise}
*/
async refund(transactionId, amount, reason = null) {
try {
const refundObj = {
charge: transactionId,
amount: amount * 100
}
if (reason !== null) {
refundObj.reason = reason
}
return await stripe.refunds.create(refundObj)
} catch (err) {
// istanbul ignore next
throw err
}
}
}
}