-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathplugin.json
More file actions
1066 lines (1066 loc) · 41.3 KB
/
plugin.json
File metadata and controls
1066 lines (1066 loc) · 41.3 KB
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
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"name": "workflow-plugin-payments",
"version": "0.0.0",
"description": "Multi-provider payment processing plugin (Stripe, PayPal)",
"author": "GoCodeAlone",
"license": "Apache-2.0",
"type": "external",
"tier": "core",
"private": false,
"minEngineVersion": "0.53.0",
"required_secrets": [
{
"name": "STRIPE_SECRET_KEY",
"sensitive": true,
"description": "Stripe secret API key (provider: stripe). PayPal deployments instead provision PAYPAL_CLIENT_ID + PAYPAL_CLIENT_SECRET. Referenced as ${STRIPE_SECRET_KEY}.",
"prompt": "Stripe secret key"
},
{
"name": "STRIPE_WEBHOOK_SECRET",
"sensitive": true,
"description": "Stripe webhook signing secret; required for step.payment_webhook_verify. Referenced as ${STRIPE_WEBHOOK_SECRET}.",
"prompt": "Stripe webhook signing secret"
}
],
"keywords": [
"payments",
"stripe",
"paypal",
"billing",
"checkout",
"subscriptions"
],
"homepage": "https://github.com/GoCodeAlone/workflow-plugin-payments",
"repository": "https://github.com/GoCodeAlone/workflow-plugin-payments",
"capabilities": {
"configProvider": false,
"moduleTypes": [
"payments.provider"
],
"stepTypes": [
"step.payment_charge",
"step.payment_capture",
"step.payment_refund",
"step.payment_fee_calculate",
"step.payment_customer_ensure",
"step.payment_subscription_create",
"step.payment_subscription_update",
"step.payment_subscription_cancel",
"step.payment_checkout_create",
"step.payment_portal_create",
"step.payment_webhook_verify",
"step.payment_webhook_endpoint_ensure",
"step.payment_transfer",
"step.payment_payout",
"step.payment_invoice_list",
"step.payment_method_attach",
"step.payment_method_list"
],
"triggerTypes": [],
"cliCommands": [
{
"name": "payments",
"description": "Payment provider operations (webhook ensure, …)",
"flagsPassthrough": true
}
]
},
"stepSchemas": [
{
"type": "step.payment_charge",
"plugin": "workflow-plugin-payments",
"description": "Creates a payment charge (PaymentIntent) via the configured payment provider. Supports automatic and manual capture.",
"configFields": [
{
"key": "module",
"label": "Payment Provider Module",
"type": "string",
"description": "Name of the payments.provider module instance to use",
"defaultValue": "payments"
},
{
"key": "amount",
"label": "Amount (cents)",
"type": "string",
"required": true,
"description": "Charge amount in the smallest currency unit (e.g. cents for USD). String so YAML templates render directly."
},
{
"key": "currency",
"label": "Currency",
"type": "string",
"description": "ISO 4217 currency code (e.g. usd). Falls back to provider default."
},
{
"key": "customer_id",
"label": "Customer ID",
"type": "string",
"description": "Provider customer ID to attach the charge to"
},
{
"key": "capture_method",
"label": "Capture Method",
"type": "select",
"options": [
"automatic",
"manual"
],
"defaultValue": "automatic",
"description": "Whether to capture funds immediately (automatic) or hold for manual capture later"
},
{
"key": "description",
"label": "Description",
"type": "string",
"description": "Optional description attached to the charge"
}
],
"outputs": [
{
"key": "charge_id",
"type": "string",
"description": "Provider-assigned charge/PaymentIntent ID"
},
{
"key": "client_secret",
"type": "string",
"description": "Client secret for client-side confirmation (Stripe only)"
},
{
"key": "status",
"type": "string",
"description": "Charge status (e.g. requires_payment_method, succeeded)"
},
{
"key": "amount",
"type": "number",
"description": "Confirmed charge amount in smallest currency unit"
},
{
"key": "error",
"type": "string",
"description": "Error message if the step failed; omitted on success"
}
]
},
{
"type": "step.payment_capture",
"plugin": "workflow-plugin-payments",
"description": "Captures a previously authorised charge that was created with capture_method=manual.",
"configFields": [
{
"key": "module",
"label": "Payment Provider Module",
"type": "string",
"description": "Name of the payments.provider module instance to use",
"defaultValue": "payments"
},
{
"key": "charge_id",
"label": "Charge ID",
"type": "string",
"required": true,
"description": "The charge/PaymentIntent ID to capture"
},
{
"key": "amount",
"label": "Capture Amount (cents)",
"type": "number",
"description": "Amount to capture. Defaults to full authorised amount when omitted."
}
],
"outputs": [
{
"key": "status",
"type": "string",
"description": "Charge status after capture"
},
{
"key": "amount",
"type": "number",
"description": "Captured amount in smallest currency unit"
},
{
"key": "error",
"type": "string",
"description": "Error message if the step failed; omitted on success"
}
]
},
{
"type": "step.payment_refund",
"plugin": "workflow-plugin-payments",
"description": "Issues a full or partial refund for a completed charge.",
"configFields": [
{
"key": "module",
"label": "Payment Provider Module",
"type": "string",
"description": "Name of the payments.provider module instance to use",
"defaultValue": "payments"
},
{
"key": "charge_id",
"label": "Charge ID",
"type": "string",
"required": true,
"description": "The charge/PaymentIntent ID to refund"
},
{
"key": "amount",
"label": "Refund Amount (cents)",
"type": "number",
"description": "Amount to refund in smallest currency unit. Defaults to full charge amount."
},
{
"key": "reason",
"label": "Reason",
"type": "string",
"description": "Optional refund reason (e.g. duplicate, fraudulent, requested_by_customer)"
}
],
"outputs": [
{
"key": "refund_id",
"type": "string",
"description": "Provider-assigned refund ID"
},
{
"key": "status",
"type": "string",
"description": "Refund status (e.g. succeeded, pending)"
},
{
"key": "error",
"type": "string",
"description": "Error message if the step failed; omitted on success"
}
]
},
{
"type": "step.payment_fee_calculate",
"plugin": "workflow-plugin-payments",
"description": "Calculates the fee breakdown for a given amount, returning the net contribution after processing and platform fees.",
"configFields": [
{
"key": "module",
"label": "Payment Provider Module",
"type": "string",
"description": "Name of the payments.provider module instance to use",
"defaultValue": "payments"
},
{
"key": "amount",
"label": "Amount (cents)",
"type": "number",
"required": true,
"description": "Gross amount in smallest currency unit"
},
{
"key": "currency",
"label": "Currency",
"type": "string",
"description": "ISO 4217 currency code"
},
{
"key": "platform_fee_percent",
"label": "Platform Fee (%)",
"type": "string",
"description": "Platform fee percentage (0-100). String so YAML templates render directly. Defaults to \"0\".",
"defaultValue": "0"
}
],
"outputs": [
{
"key": "contribution_amount",
"type": "number",
"description": "Net amount after all fees (in cents)"
},
{
"key": "processing_fee",
"type": "number",
"description": "Payment processor fee (in cents)"
},
{
"key": "platform_fee",
"type": "number",
"description": "Platform fee (in cents)"
},
{
"key": "total_charge",
"type": "number",
"description": "Gross charge amount (in cents)"
},
{
"key": "error",
"type": "string",
"description": "Error message if the step failed; omitted on success"
}
]
},
{
"type": "step.payment_customer_ensure",
"plugin": "workflow-plugin-payments",
"description": "Looks up an existing customer by email and creates one if not found (idempotent upsert).",
"configFields": [
{
"key": "module",
"label": "Payment Provider Module",
"type": "string",
"description": "Name of the payments.provider module instance to use",
"defaultValue": "payments"
},
{
"key": "email",
"label": "Email",
"type": "string",
"required": true,
"description": "Customer email address"
},
{
"key": "name",
"label": "Name",
"type": "string",
"description": "Customer full name"
}
],
"outputs": [
{
"key": "customer_id",
"type": "string",
"description": "Provider-assigned customer ID"
},
{
"key": "email",
"type": "string",
"description": "Customer email address"
},
{
"key": "name",
"type": "string",
"description": "Customer full name"
},
{
"key": "error",
"type": "string",
"description": "Error message if the step failed; omitted on success"
}
]
},
{
"type": "step.payment_subscription_create",
"plugin": "workflow-plugin-payments",
"description": "Creates a new recurring subscription for a customer. Two pricing modes: supply price_id for an existing Price, or supply amount + currency + interval for inline pricing.",
"configFields": [
{
"key": "module",
"label": "Payment Provider Module",
"type": "string",
"description": "Name of the payments.provider module instance to use",
"defaultValue": "payments"
},
{
"key": "customer_id",
"label": "Customer ID",
"type": "string",
"required": true,
"description": "Provider customer ID"
},
{
"key": "price_id",
"label": "Price ID",
"type": "string",
"description": "Provider price/plan ID to subscribe to. When empty, supply amount + currency + interval for inline pricing."
},
{
"key": "amount",
"label": "Amount (cents)",
"type": "string",
"description": "Per-interval amount in smallest currency unit. Used for inline pricing when price_id is empty. String so YAML templates render directly."
},
{
"key": "currency",
"label": "Currency",
"type": "string",
"description": "ISO 4217 currency code. Used for inline pricing when price_id is empty."
},
{
"key": "interval",
"label": "Interval",
"type": "select",
"options": [
"day",
"week",
"month",
"year"
],
"description": "Billing frequency. Used for inline pricing when price_id is empty."
}
],
"outputs": [
{
"key": "subscription_id",
"type": "string",
"description": "Provider-assigned subscription ID"
},
{
"key": "status",
"type": "string",
"description": "Subscription status (e.g. active, trialing, incomplete)"
},
{
"key": "error",
"type": "string",
"description": "Error message if the step failed; omitted on success"
}
]
},
{
"type": "step.payment_subscription_update",
"plugin": "workflow-plugin-payments",
"description": "Updates an existing subscription, e.g. to change the price/plan.",
"configFields": [
{
"key": "module",
"label": "Payment Provider Module",
"type": "string",
"description": "Name of the payments.provider module instance to use",
"defaultValue": "payments"
},
{
"key": "subscription_id",
"label": "Subscription ID",
"type": "string",
"required": true,
"description": "Provider subscription ID to update"
},
{
"key": "price_id",
"label": "New Price ID",
"type": "string",
"description": "New provider price/plan ID to switch to"
}
],
"outputs": [
{
"key": "subscription_id",
"type": "string",
"description": "Provider-assigned subscription ID"
},
{
"key": "status",
"type": "string",
"description": "Subscription status after update"
},
{
"key": "error",
"type": "string",
"description": "Error message if the step failed; omitted on success"
}
]
},
{
"type": "step.payment_subscription_cancel",
"plugin": "workflow-plugin-payments",
"description": "Cancels an active subscription immediately or at the end of the current billing period.",
"configFields": [
{
"key": "module",
"label": "Payment Provider Module",
"type": "string",
"description": "Name of the payments.provider module instance to use",
"defaultValue": "payments"
},
{
"key": "subscription_id",
"label": "Subscription ID",
"type": "string",
"required": true,
"description": "Provider subscription ID to cancel"
},
{
"key": "cancel_at_period_end",
"label": "Cancel at Period End",
"type": "boolean",
"defaultValue": false,
"description": "When true, the subscription remains active until the end of the billing period"
}
],
"outputs": [
{
"key": "subscription_id",
"type": "string",
"description": "Provider-assigned subscription ID"
},
{
"key": "status",
"type": "string",
"description": "Subscription status after cancellation"
},
{
"key": "error",
"type": "string",
"description": "Error message if the step failed; omitted on success"
}
]
},
{
"type": "step.payment_checkout_create",
"plugin": "workflow-plugin-payments",
"description": "Creates a hosted checkout session URL that redirects the customer to the provider's payment page.",
"configFields": [
{
"key": "module",
"label": "Payment Provider Module",
"type": "string",
"description": "Name of the payments.provider module instance to use",
"defaultValue": "payments"
},
{
"key": "customer_id",
"label": "Customer ID",
"type": "string",
"description": "Provider customer ID (optional for guest checkout)"
},
{
"key": "price_id",
"label": "Price ID",
"type": "string",
"required": true,
"description": "Provider price/product ID for the checkout item"
},
{
"key": "success_url",
"label": "Success URL",
"type": "string",
"required": true,
"description": "URL to redirect to after successful payment"
},
{
"key": "cancel_url",
"label": "Cancel URL",
"type": "string",
"required": true,
"description": "URL to redirect to when the customer cancels"
},
{
"key": "mode",
"label": "Mode",
"type": "select",
"options": [
"subscription",
"payment",
"setup"
],
"defaultValue": "subscription",
"description": "Checkout session mode"
}
],
"outputs": [
{
"key": "url",
"type": "string",
"description": "Hosted checkout page URL to redirect the customer to"
},
{
"key": "session_id",
"type": "string",
"description": "Provider-assigned checkout session ID"
},
{
"key": "error",
"type": "string",
"description": "Error message if the step failed; omitted on success"
}
]
},
{
"type": "step.payment_portal_create",
"plugin": "workflow-plugin-payments",
"description": "Creates a customer billing-portal session URL where the customer can manage their subscriptions and payment methods.",
"configFields": [
{
"key": "module",
"label": "Payment Provider Module",
"type": "string",
"description": "Name of the payments.provider module instance to use",
"defaultValue": "payments"
},
{
"key": "customer_id",
"label": "Customer ID",
"type": "string",
"required": true,
"description": "Provider customer ID"
},
{
"key": "return_url",
"label": "Return URL",
"type": "string",
"description": "URL to redirect to after the customer exits the portal"
}
],
"outputs": [
{
"key": "url",
"type": "string",
"description": "Billing portal URL to redirect the customer to"
},
{
"key": "session_id",
"type": "string",
"description": "Provider-assigned portal session ID"
},
{
"key": "error",
"type": "string",
"description": "Error message if the step failed; omitted on success"
}
]
},
{
"type": "step.payment_webhook_verify",
"plugin": "workflow-plugin-payments",
"description": "Validates an inbound webhook payload signature and returns the parsed event. Reads signature headers from the pipeline context or config.",
"configFields": [
{
"key": "module",
"label": "Payment Provider Module",
"type": "string",
"description": "Name of the payments.provider module instance to use",
"defaultValue": "payments"
},
{
"key": "request_body",
"label": "Request Body",
"type": "string",
"description": "Raw webhook payload body (falls back to current.payload)"
},
{
"key": "Stripe-Signature",
"label": "Stripe-Signature Header",
"type": "string",
"description": "Stripe webhook signature header value"
},
{
"key": "stripe_signature",
"label": "Stripe Signature (alias)",
"type": "string",
"description": "Alternative key for Stripe-Signature"
},
{
"key": "webhook_signature",
"label": "Webhook Signature (legacy alias)",
"type": "string",
"description": "Legacy alias for Stripe-Signature; mapped to Stripe-Signature header automatically"
},
{
"key": "Paypal-Transmission-Id",
"label": "PayPal-Transmission-Id Header",
"type": "string",
"description": "PayPal webhook transmission ID header"
},
{
"key": "Paypal-Transmission-Sig",
"label": "PayPal-Transmission-Sig Header",
"type": "string",
"description": "PayPal webhook signature header"
},
{
"key": "Paypal-Cert-Url",
"label": "PayPal-Cert-Url Header",
"type": "string",
"description": "PayPal webhook certificate URL header"
},
{
"key": "Paypal-Auth-Algo",
"label": "PayPal-Auth-Algo Header",
"type": "string",
"description": "PayPal webhook auth algorithm header"
},
{
"key": "Paypal-Transmission-Time",
"label": "PayPal-Transmission-Time Header",
"type": "string",
"description": "PayPal webhook transmission time header"
}
],
"outputs": [
{
"key": "event_type",
"type": "string",
"description": "Provider event type (e.g. payment_intent.succeeded)"
},
{
"key": "event_id",
"type": "string",
"description": "Provider-assigned event ID"
},
{
"key": "data",
"type": "json",
"description": "Parsed event data payload"
},
{
"key": "metadata",
"type": "json",
"description": "Event metadata map"
},
{
"key": "error",
"type": "string",
"description": "Error message if the step failed; omitted on success"
}
]
},
{
"type": "step.payment_webhook_endpoint_ensure",
"plugin": "workflow-plugin-payments",
"description": "Idempotently provisions a provider webhook endpoint. URL match + identical events → no-op. URL match + drift → updates events. No URL match → creates and returns signing_secret. Mode 'replace' deletes+creates to rotate the signing secret.",
"configFields": [
{
"key": "module",
"label": "Payment Provider Module",
"type": "string",
"description": "Name of the payments.provider module instance to use",
"defaultValue": "payments"
},
{
"key": "url",
"label": "Webhook URL",
"type": "string",
"required": true,
"description": "https URL the provider will POST events to"
},
{
"key": "events",
"label": "Events",
"type": "array",
"items": {
"type": "string"
},
"required": true,
"description": "List of provider event names (sort/dedup is automatic)"
},
{
"key": "description",
"label": "Description",
"type": "string",
"description": "Optional human-readable description stored on the endpoint"
},
{
"key": "mode",
"label": "Mode",
"type": "select",
"options": [
"ensure",
"replace"
],
"defaultValue": "ensure",
"description": "ensure (idempotent) or replace (rotates signing secret — destructive)"
}
],
"outputs": [
{
"key": "endpoint_id",
"type": "string",
"description": "Provider-assigned endpoint ID (we_… for Stripe)"
},
{
"key": "created",
"type": "boolean",
"description": "True on fresh-create branch; false on no-op or update"
},
{
"key": "events_drift",
"type": "boolean",
"description": "True when events list was patched on an existing endpoint"
},
{
"key": "signing_secret",
"type": "string",
"description": "Webhook signing secret. Populated only when created=true; empty on every other branch (V3 invariant)."
},
{
"key": "error",
"type": "string",
"description": "Error message if the step failed; omitted on success"
}
]
},
{
"type": "step.payment_transfer",
"plugin": "workflow-plugin-payments",
"description": "Initiates a platform-level transfer of funds to a connected account.",
"configFields": [
{
"key": "module",
"label": "Payment Provider Module",
"type": "string",
"description": "Name of the payments.provider module instance to use",
"defaultValue": "payments"
},
{
"key": "amount",
"label": "Amount (cents)",
"type": "number",
"required": true,
"description": "Transfer amount in smallest currency unit"
},
{
"key": "currency",
"label": "Currency",
"type": "string",
"description": "ISO 4217 currency code"
},
{
"key": "destination_account_id",
"label": "Destination Account ID",
"type": "string",
"required": true,
"description": "Connected account or PayPal ID to transfer funds to"
},
{
"key": "description",
"label": "Description",
"type": "string",
"description": "Optional transfer description"
}
],
"outputs": [
{
"key": "transfer_id",
"type": "string",
"description": "Provider-assigned transfer ID"
},
{
"key": "status",
"type": "string",
"description": "Transfer status"
},
{
"key": "error",
"type": "string",
"description": "Error message if the step failed; omitted on success"
}
]
},
{
"type": "step.payment_payout",
"plugin": "workflow-plugin-payments",
"description": "Initiates a payout of funds to an external bank account.",
"configFields": [
{
"key": "module",
"label": "Payment Provider Module",
"type": "string",
"description": "Name of the payments.provider module instance to use",
"defaultValue": "payments"
},
{
"key": "amount",
"label": "Amount (cents)",
"type": "number",
"required": true,
"description": "Payout amount in smallest currency unit"
},
{
"key": "currency",
"label": "Currency",
"type": "string",
"description": "ISO 4217 currency code"
},
{
"key": "destination_bank_id",
"label": "Destination Bank ID",
"type": "string",
"description": "Bank account or payout destination ID"
},
{
"key": "description",
"label": "Description",
"type": "string",
"description": "Optional payout description"
}
],
"outputs": [
{
"key": "payout_id",
"type": "string",
"description": "Provider-assigned payout ID"
},
{
"key": "status",
"type": "string",
"description": "Payout status (e.g. paid, pending, in_transit)"
},
{
"key": "error",
"type": "string",
"description": "Error message if the step failed; omitted on success"
}
]
},
{
"type": "step.payment_invoice_list",
"plugin": "workflow-plugin-payments",
"description": "Lists invoices for a customer, with optional status and limit filters.",
"configFields": [
{
"key": "module",
"label": "Payment Provider Module",
"type": "string",
"description": "Name of the payments.provider module instance to use",
"defaultValue": "payments"
},
{
"key": "customer_id",
"label": "Customer ID",
"type": "string",
"description": "Provider customer ID to filter invoices by"
},
{
"key": "limit",
"label": "Limit",
"type": "number",
"description": "Maximum number of invoices to return",
"defaultValue": 10
},
{
"key": "status",
"label": "Status Filter",
"type": "string",
"description": "Filter by invoice status (e.g. paid, open, draft)"
}
],
"outputs": [
{
"key": "invoices",
"type": "string",
"description": "JSON-encoded array of invoice objects"
},
{
"key": "count",
"type": "number",
"description": "Number of invoices returned"
},
{
"key": "error",
"type": "string",
"description": "Error message if the step failed; omitted on success"
}
]
},
{
"type": "step.payment_method_attach",
"plugin": "workflow-plugin-payments",
"description": "Attaches an existing payment method to a customer.",
"configFields": [
{
"key": "module",
"label": "Payment Provider Module",
"type": "string",
"description": "Name of the payments.provider module instance to use",
"defaultValue": "payments"
},
{
"key": "customer_id",
"label": "Customer ID",
"type": "string",
"required": true,
"description": "Provider customer ID"
},
{
"key": "payment_method_id",
"label": "Payment Method ID",
"type": "string",
"required": true,
"description": "Provider payment method ID to attach"
}
],
"outputs": [
{
"key": "payment_method_id",
"type": "string",
"description": "Provider-assigned payment method ID"
},
{
"key": "type",
"type": "string",
"description": "Payment method type (e.g. card, sepa_debit)"
},
{
"key": "error",
"type": "string",
"description": "Error message if the step failed; omitted on success"
}
]
},
{
"type": "step.payment_method_list",