Stripe
Implementation Summary
Fidesops uses the following Stripe endpoints to retrieve and delete Personally Identifiable Information (PII) when processing a Data Subject Request (DSR). Right to Access and Right to Delete (Right to Forget) support for each endpoint is noted below.
Connection Settings
Fidesops provides a Postman collection for easily establishing connections to your third party applications. Additional connection instructions may be found in the configuration guide.
Deletion requests are fulfilled by masking PII via UPDATE endpoints. To give fidesops permission to remove PII using DELETE endpoints, ensure the masking_strict variable in your fidesops.toml file is set to false.
Example Stripe Configuration
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
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437 | saas_config:
fides_key: stripe_connector_example
name: Stripe SaaS Config
description: A sample schema representing the Stripe connector for fidesops
version: 0.0.1
connector_params:
- name: host
- name: api_key
- name: payment_types
- name: items_per_page
client_config:
protocol: https
host:
connector_param: host
authentication:
strategy: bearer_authentication
configuration:
token:
connector_param: api_key
test_request:
method: GET
path: /v1/customers
endpoints:
- name: customer
requests:
read:
method: GET
path: /v1/customers
query_params:
- name: email
value: <email>
param_values:
- name: email
identity: email
data_path: data
update:
method: POST
path: /v1/customers/<customer_id>
headers:
- name: Content-Type
value: application/x-www-form-urlencoded
param_values:
- name: customer_id
references:
- dataset: stripe_connector_example
field: customer.id
direction: from
body: '{<all_object_fields>}'
- name: charge
requests:
read:
method: GET
path: /v1/charges
query_params:
- name: customer
value: <customer_id>
- name: limit
value: <limit>
param_values:
- name: customer_id
references:
- dataset: stripe_connector_example
field: customer.id
direction: from
- name: limit
connector_param: items_per_page
data_path: data
pagination:
strategy: cursor
configuration:
cursor_param: starting_after
field: id
- name: dispute
requests:
read:
method: GET
path: /v1/disputes
query_params:
- name: charge
value: <charge_id>
- name: payment_intent
value: <payment_intent_id>
- name: limit
value: <limit>
param_values:
- name: charge_id
references:
- dataset: stripe_connector_example
field: charge.id
direction: from
- name: payment_intent_id
references:
- dataset: stripe_connector_example
field: payment_intent.id
direction: from
- name: limit
connector_param: items_per_page
data_path: data
pagination:
strategy: cursor
configuration:
cursor_param: starting_after
field: id
- name: payment_intent
requests:
read:
method: GET
path: /v1/payment_intents
query_params:
- name: customer
value: <customer_id>
- name: limit
value: <limit>
param_values:
- name: customer_id
references:
- dataset: stripe_connector_example
field: customer.id
direction: from
- name: limit
connector_param: items_per_page
data_path: data
pagination:
strategy: cursor
configuration:
cursor_param: starting_after
field: id
- name: payment_method
requests:
read:
method: GET
path: /v1/customers/<customer_id>/payment_methods
query_params:
- name: type
value: <type>
- name: limit
value: <limit>
param_values:
- name: customer_id
references:
- dataset: stripe_connector_example
field: customer.id
direction: from
- name: type
connector_param: payment_types
- name: limit
connector_param: items_per_page
data_path: data
pagination:
strategy: cursor
configuration:
cursor_param: starting_after
field: id
update:
method: POST
path: /v1/payment_methods/<payment_method_id>
headers:
- name: Content-Type
value: application/x-www-form-urlencoded
param_values:
- name: payment_method_id
references:
- dataset: stripe_connector_example
field: payment_method.id
direction: from
body: '{<masked_object_fields>}'
- name: bank_account
requests:
read:
method: GET
path: /v1/customers/<customer_id>/sources
query_params:
- name: object
value: bank_account
- name: limit
value: <limit>
param_values:
- name: customer_id
references:
- dataset: stripe_connector_example
field: customer.id
direction: from
- name: limit
connector_param: items_per_page
data_path: data
pagination:
strategy: cursor
configuration:
cursor_param: starting_after
field: id
update:
method: POST
path: /v1/customers/<customer_id>/sources/<bank_account_id>
headers:
- name: Content-Type
value: application/x-www-form-urlencoded
param_values:
- name: customer_id
references:
- dataset: stripe_connector_example
field: bank_account.customer
direction: from
- name: bank_account_id
references:
- dataset: stripe_connector_example
field: bank_account.id
direction: from
body: '{<masked_object_fields>}'
- name: card
requests:
read:
method: GET
path: /v1/customers/<customer_id>/sources
query_params:
- name: object
value: card
- name: limit
value: <limit>
param_values:
- name: customer_id
references:
- dataset: stripe_connector_example
field: customer.id
direction: from
- name: limit
connector_param: items_per_page
data_path: data
pagination:
strategy: cursor
configuration:
cursor_param: starting_after
field: id
update:
method: POST
path: /v1/customers/<customer_id>/sources/<card_id>
headers:
- name: Content-Type
value: application/x-www-form-urlencoded
param_values:
- name: customer_id
references:
- dataset: stripe_connector_example
field: card.customer
direction: from
- name: card_id
references:
- dataset: stripe_connector_example
field: card.id
direction: from
body: '{<masked_object_fields>}'
- name: credit_note
requests:
read:
method: GET
path: /v1/credit_notes
query_params:
- name: customer
value: <customer_id>
- name: limit
value: <limit>
param_values:
- name: customer_id
references:
- dataset: stripe_connector_example
field: customer.id
direction: from
- name: limit
connector_param: items_per_page
data_path: data
pagination:
strategy: cursor
configuration:
cursor_param: starting_after
field: id
- name: customer_balance_transaction
requests:
read:
method: GET
path: /v1/customers/<customer_id>/balance_transactions
query_params:
- name: limit
value: <limit>
param_values:
- name: customer_id
references:
- dataset: stripe_connector_example
field: customer.id
direction: from
- name: limit
connector_param: items_per_page
data_path: data
pagination:
strategy: cursor
configuration:
cursor_param: starting_after
field: id
- name: tax_id
requests:
read:
method: GET
path: /v1/customers/<customer_id>/tax_ids
query_params:
- name: limit
value: <limit>
param_values:
- name: customer_id
references:
- dataset: stripe_connector_example
field: customer.id
direction: from
- name: limit
connector_param: items_per_page
data_path: data
pagination:
strategy: cursor
configuration:
cursor_param: starting_after
field: id
delete:
method: DELETE
path: /v1/customers/<customer_id>/tax_ids/<tax_id>
param_values:
- name: customer_id
references:
- dataset: stripe_connector_example
field: tax_id.customer
direction: from
- name: tax_id
references:
- dataset: stripe_connector_example
field: tax_id.id
direction: from
- name: invoice
requests:
read:
method: GET
path: /v1/invoices
query_params:
- name: customer
value: <customer_id>
- name: limit
value: <limit>
param_values:
- name: customer_id
references:
- dataset: stripe_connector_example
field: customer.id
direction: from
- name: limit
connector_param: items_per_page
data_path: data
pagination:
strategy: cursor
configuration:
cursor_param: starting_after
field: id
delete:
method: DELETE
ignore_errors: true # You can only delete draft invoices. You can't delete invoices created by subscriptions.
path: /v1/invoices/<invoice_id>
param_values:
- name: invoice_id
references:
- dataset: stripe_connector_example
field: invoice.id
direction: from
- name: invoice_item
requests:
read:
method: GET
path: /v1/invoiceitems
query_params:
- name: customer
value: <customer_id>
- name: limit
value: <limit>
param_values:
- name: customer_id
references:
- dataset: stripe_connector_example
field: customer.id
direction: from
- name: limit
connector_param: items_per_page
data_path: data
pagination:
strategy: cursor
configuration:
cursor_param: starting_after
field: id
delete:
method: DELETE
ignore_errors: true # Can't delete an invoice item that is attached to an invoice that is no longer editable
path: /v1/invoiceitems/<invoice_item_id>
param_values:
- name: invoice_item_id
references:
- dataset: stripe_connector_example
field: invoice_item.id
direction: from
- name: subscription
requests:
read:
method: GET
path: /v1/subscriptions
query_params:
- name: customer
value: <customer_id>
- name: limit
value: <limit>
param_values:
- name: customer_id
references:
- dataset: stripe_connector_example
field: customer.id
direction: from
- name: limit
connector_param: items_per_page
data_path: data
pagination:
strategy: cursor
configuration:
cursor_param: starting_after
field: id
delete:
method: DELETE
path: /v1/subscriptions/<subscription_id>
param_values:
- name: subscription_id
references:
- dataset: stripe_connector_example
field: subscription.id
direction: from
|