-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
4399 lines (4302 loc) · 151 KB
/
openapi.yaml
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
openapi: 3.0.3
info:
summary: Pay.com API
title: Pay.com API
description: ''
version: '1.0'
contact:
name: Pay.com Team
url: https://pay.com
email: support@pay.com
termsOfService: https://pay.com/legal/terms-and-conditions
x-konfig-ignore:
object-with-no-properties: true
potential-incorrect-type: true
servers:
- description: Test mode (Sandbox)
url: https://api.sandbox.pay.com
- description: Live mode (Production)
url: https://api.pay.com
tags:
- name: Session
- name: Hold
- name: Customer
- name: Charge
- name: PaymentMethod
- name: Refund
- name: Payout
- name: Attempt
paths:
/v1/sessions/payment:
parameters: []
post:
tags:
- Session
summary: Create a Payment Session
operationId: Session_createPayment
description: >-
Create a new Payment Session
After a Payment Session is successfully confirmed by the customer, a
Charge (or a Hold when `capture=false`) will be created and executed
with the payment method entered by the customer during the session.
requestBody:
$ref: '#/components/requestBodies/Create-Payment-Session'
responses:
'200':
$ref: '#/components/responses/Create-Payment-Session'
/v1/sessions/payment/{id}:
parameters:
- description: The id of the Payment Session to retrieve.
schema:
type: string
example: ps_217940156986951680
pattern: ^ps_\d{18,20}
name: id
in: path
required: true
get:
tags:
- Session
summary: Retrieve a Payment Session
operationId: Session_getPaymentDetails
description: >-
Retrieves the details of a Payment Session.
Querying the API with the unique identifier of a Payment Session that
was returned from a previous request will return the corresponding
Payment Session information.
responses:
'200':
$ref: '#/components/responses/Payment-Session'
/v1/sessions/setup:
parameters: []
post:
tags:
- Session
summary: Create a Setup Session
operationId: Session_createSetup
description: >-
Create a new Setup Session
After a Setup Session is successfully confirmed by the customer, a
Payment Method will be created and can be used to create Charges or
Holds from the API.
requestBody:
$ref: '#/components/requestBodies/Create-Setup-Session'
responses:
'200':
$ref: '#/components/responses/Create-Setup-Session'
/v1/sessions/setup/{id}:
parameters:
- description: The id of the Setup Session to retrieve.
schema:
type: string
example: ss_217940156986951680
pattern: ^ss_\d{18,20}
name: id
in: path
required: true
get:
tags:
- Session
summary: Retrieve a Setup Session
operationId: Session_getDetails
description: >-
Retrieves the details of a Setup Session.
Querying the API with the unique identifier of a Setup Session that was
returned from a previous request will return the corresponding Setup
Session information.
responses:
'200':
$ref: '#/components/responses/Setup-Session'
/v1/sessions/payment/{id}/attempts:
parameters:
- description: The id of the Payment Session to retrieve attempts for.
schema:
type: string
example: ps_217940156986951680
pattern: ^ps_\d{18,20}
name: id
in: path
required: true
get:
tags:
- Session
summary: Retrieve Attempts of a Session
operationId: Session_getAttempts
description: >-
Retrieves the details of a Payment Session.
Querying the API with the unique identifier of a Payment Session that
was returned from a previous request will return the corresponding
Payment Attempts.
responses:
'200':
$ref: '#/components/responses/Payment-Attempts'
/v1/sessions/setup/{id}/attempts:
parameters:
- description: The id of the Setup Session to retrieve attempts for.
schema:
type: string
example: ss_217940156986951680
pattern: ^ss_\d{18,20}
name: id
in: path
required: true
get:
tags:
- Session
summary: Retrieve Attempts of a Session
operationId: Session_getSessionAttempts
description: >-
Retrieves the details of a Setup Session.
Querying the API with the unique identifier of a Setup Session that was
returned from a previous request will return the corresponding Setup
Attempts.
responses:
'200':
$ref: '#/components/responses/Setup-Attempts'
/v1/sessions/authentication/linked:
parameters: []
post:
tags:
- Session
summary: Create a Linked Session
operationId: Session_createLinked
description: >-
Create a new Linked Authentication Session
A Linked Authentication Session can be used to authenticate a Charge or
Hold with a `requires_authentication` status.
requestBody:
$ref: '#/components/requestBodies/Create-a-Linked-Authentication-Session'
responses:
'200':
$ref: '#/components/responses/Authentication-Session'
/v1/sessions/authentication/independent:
parameters: []
post:
tags:
- Session
summary: Create an Independent Session
operationId: Session_createIndependent
description: >-
Create a new Independent Authentication Session
An Independent Authentication Session can be used to authentication a
payment with SCA, without proccessing a payment.
requestBody:
$ref: >-
#/components/requestBodies/Create-an-Independent-Authentication-Session
responses:
'200':
$ref: '#/components/responses/Authentication-Session'
/v1/attempts/payment/{id}:
parameters:
- description: The id of the Payment Session to retrieve.
schema:
type: string
example: psatt_217940156986951680_0
pattern: ^psatt_\d{18,20}_\d{1}
name: id
in: path
required: true
get:
tags:
- Session
summary: Retrieve a Payment Session
operationId: Session_getPaymentAttempt
description: >-
Retrieves the details of a Payment Attempt.
Querying the API with the unique identifier of a Payment Attempt that
was returned from a previous request will return the corresponding
Payment Attempt information.
responses:
'200':
$ref: '#/components/responses/Payment-Attempt'
/v1/attempts/setup/{id}:
parameters:
- description: The id of the Setup Attempt to retrieve.
schema:
type: string
example: ssatt_217940156986951680_0
pattern: ^ssatt_\d{18,20}_\d{1}
name: id
in: path
required: true
get:
tags:
- Attempt
summary: Retrieve a Setup Attempt
operationId: Attempt_getDetails
description: >-
Retrieves the details of a Setup Attempt.
Querying the API with the unique identifier of a Setup Attempt that was
returned from a previous request will return the corresponding Setup
Attempt information.
responses:
'200':
$ref: '#/components/responses/Setup-Attempt'
/v1/charges:
parameters: []
post:
tags:
- Charge
summary: Create a Charge
operationId: Charge_createCharge
requestBody:
$ref: '#/components/requestBodies/Create-Charge'
responses:
'200':
$ref: '#/components/responses/Charge'
/v1/charges/{id}:
parameters:
- description: The id of the Charge to retrieve.
schema:
type: string
example: chrg_146231656762572800
pattern: ^chrg_\d{18,20}
name: id
in: path
required: true
get:
tags:
- Charge
summary: Retrieve a Charge
operationId: Charge_getDetails
description: >-
Retrieves the details of a Charge.
Querying the API with the unique identifier of a Charge that was
returned from a previous request will return the corresponding Charge
information.
responses:
'200':
$ref: '#/components/responses/Charge'
/v1/charges/{id}/confirm:
parameters:
- description: The id of the Charge to confirm.
schema:
type: string
example: chrg_146231656762572800
pattern: ^chrg_\d{18,20}
name: id
in: path
required: true
post:
tags:
- Charge
summary: Confirm a Charge
operationId: Charge_confirmCharge
description: >-
Confirms a Charge with status of `requires_confirmation` after
successful authentication.
responses:
'200':
$ref: '#/components/responses/Charge'
/v1/refunds:
parameters: []
post:
tags:
- Refund
summary: Create a Refund
operationId: Refund_paymentMethod
description: >-
Refund the funds from a Charge to the Payment Method.
Creating a Refund will refund a Charge that has previously been
created.
Funds will be returned to the Payment Method that was originally
charged.
You can optionally refund only part of a charge.
You can do so multiple times, until the entire charge has been refunded.
requestBody:
$ref: '#/components/requestBodies/Create-Refund'
responses:
'200':
$ref: '#/components/responses/Refund'
/v1/refunds/{id}:
parameters:
- description: The id of the Refund to retrieve.
schema:
type: string
example: rfnd_179937907841176576
pattern: ^rfnd_\d{18,20}
name: id
in: path
required: true
get:
tags:
- Refund
summary: Retrieve a Refund
operationId: Refund_getDetails
description: >-
Retrieves the details of a Refund.
Querying the API with the unique identifier of a Refund that was
returned from a previous request will return the corresponding Refund
information.
responses:
'200':
$ref: '#/components/responses/Refund'
/v1/holds:
parameters: []
post:
tags:
- Hold
summary: Create a Hold
operationId: Hold_createHold
requestBody:
$ref: '#/components/requestBodies/Create-Hold'
responses:
'200':
$ref: '#/components/responses/Hold'
/v1/holds/{id}:
parameters:
- description: The id of the Hold to retrieve.
schema:
type: string
example: hld_158938670341035008
pattern: ^hld_\d{18,20}
name: id
in: path
required: true
get:
tags:
- Hold
summary: Retrieve a Hold
operationId: Hold_getDetails
description: >-
Retrieves the details of a Hold.
Querying the API with the unique identifier of a Hold that was returned
from a previous request will return the corresponding Hold information.
responses:
'200':
$ref: '#/components/responses/Hold'
/v1/holds/{id}/capture:
parameters:
- description: The identifier of the Hold to capture.
schema:
type: string
example: hld_158938670341035008
pattern: ^hld_\d{18,20}
name: id
in: path
required: true
post:
tags:
- Hold
summary: Capture a Hold
operationId: Hold_captureHold
description: >-
Capture the funds of an existing, uncaptured, Hold.
This is the second half of the two-step payment flow, where first a Hold
was created with the `/holds` API or with a Payment Session (`capture`
flag set to `false`).
The API will create a Charge from the referenced Hold and response with
the created Charge information.
requestBody:
$ref: '#/components/requestBodies/Capture-a-Hold'
responses:
'200':
$ref: '#/components/responses/Charge'
/v1/holds/{id}/cancel:
parameters:
- description: The identifier of the Hold to cancel.
schema:
type: string
example: hld_158938670341035008
pattern: ^hld_\d{18,20}
name: id
in: path
required: true
post:
tags:
- Hold
summary: Cancel a Hold
operationId: Hold_cancelHold
description: >-
Cancels the hold on a funds being held by an uncaptured Hold.
A Hold object can be canceled when it is in the status of:
`requires_capture`. Once canceled, the remaining `amount_capturable`
will automatically be released and no additional charges can be created
from the Hold.
parameters: []
responses:
'200':
$ref: '#/components/responses/Canceled-Hold'
/v1/holds/{id}/confirm:
parameters:
- description: The id of the Charge to confirm.
schema:
type: string
example: hld_146231656762572800
pattern: ^hld_\d{18,20}
name: id
in: path
required: true
post:
tags:
- Hold
summary: Confirm a Hold
operationId: Hold_confirmHoldStatus
description: >-
Confirms a Hold with status of `requires_confirmation` after successful
authentication.
responses:
'200':
$ref: '#/components/responses/Hold'
/v1/payouts:
parameters: []
post:
tags:
- Payout
summary: Create a Payout
operationId: Payout_createPayout
requestBody:
$ref: '#/components/requestBodies/Create-Payout'
responses:
'200':
$ref: '#/components/responses/Payout'
/v1/payouts/{id}:
parameters:
- description: The id of the Payout to retrieve.
schema:
type: string
example: po_220442125165133824
name: id
in: path
required: true
get:
tags:
- Payout
summary: Retrieve a Payout
operationId: Payout_getDetails
description: >-
Retrieves the details of a Payout.
Querying the API with the unique identifier of a Payout that was
returned from a previous request will return the corresponding Payout
information.
responses:
'200':
$ref: '#/components/responses/Payout'
/v1/payment_methods:
post:
tags:
- PaymentMethod
summary: Create a Payment Method
operationId: PaymentMethod_createPaymentMethod
requestBody:
$ref: '#/components/requestBodies/Create-Payment-Method'
responses:
'200':
$ref: '#/components/responses/Payment-Method'
/v1/payment_methods/{id}:
parameters:
- description: The id of the Payment Method.
schema:
type: string
example: pm_card_220442125165133824
name: id
in: path
required: true
get:
tags:
- PaymentMethod
summary: Retrieve a Payment Method
operationId: PaymentMethod_getDetails
description: >-
Retrieves the details of a Payment Method.
Querying the API with the unique identifier of a Payment Method that was
returned from a previous request will return the corresponding Payment
Method information.
responses:
'200':
$ref: '#/components/responses/Payment-Method'
delete:
tags:
- PaymentMethod
summary: Delete a Payment Method
operationId: PaymentMethod_deleteMethod
description: Delete a Payment Method.
responses:
'200':
description: OK
/v1/customers/{reference_id}/payment_methods:
parameters:
- description: The reference id of the Customer to retrieve the payment methods for.
schema:
type: string
example: 927071e4-464c-4f5d-a079-4aa097f922ca
name: reference_id
in: path
required: true
get:
tags:
- Customer
summary: Retrieve Payment Methods
operationId: Customer_getPaymentMethods
description: >-
Retrieves details of all Payment Methods associated with a customer.
Querying the API with the reference id of a customer will return the
corresponding Payment Method information.
responses:
'200':
$ref: '#/components/responses/Payment-Methods'
/v1/customers:
post:
tags:
- Customer
summary: Create a Customer
operationId: Customer_createCustomer
requestBody:
$ref: '#/components/requestBodies/Create-Customer'
responses:
'200':
$ref: '#/components/responses/Customer'
/v1/customers/{reference_id}:
parameters:
- description: The reference id of the Customer.
schema:
type: string
example: 927071e4-464c-4f5d-a079-4aa097f922ca
name: reference_id
in: path
required: true
get:
tags:
- Customer
summary: Retrieve a Customer
operationId: Customer_getDetails
description: >-
Retrieves the details of a Customer
Querying the API with the reference id of a customer will return the
corresponding Customer information.
responses:
'200':
$ref: '#/components/responses/Customer'
delete:
tags:
- Customer
summary: Delete a Customer
operationId: Customer_deleteCustomer
description: Delete a Customer
responses:
'200':
description: OK
put:
tags:
- Customer
summary: Update a Customer
operationId: Customer_updateDetails
description: Update details of a Customer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerUpdateDetailsRequest'
responses:
'200':
$ref: '#/components/responses/Customer'
components:
responses:
Setup-Attempt:
description: Example response
content:
application/json:
schema:
$ref: '#/components/schemas/Setup-Attempt'
examples:
Example response:
value:
id: ssatt_217940156986951680_0X
resource: setup_attempt
created: '2022-09-07T13:40:41.751Z'
customer: cust_222712682678060032
customer_reference_id: 927071e4-464c-4f5d-a079-4aa097f922ca
failure_code: null
failure_message: null
metadata: {}
payment_method: pm_card_202779025452569600
payment_method_details:
type: card
card:
bin: '424242'
brand: visa
country: US
exp_month: '11'
exp_year: '25'
fingerprint: >-
c5338f1c33863cce001e80648ea80df1068ed5f94dbb4bfb561ed8da8988fe0a
funding: credit
last4: '4242'
network: visa
security_checks:
address_line1_check: unavailable
address_postal_code_check: unavailable
cvc_check: pass
three_d_secure: null
token: tok_card_202779025452569600
wallet: null
reference: null
setup_session: ss_217940156986951680
status: succeeded
Payment-Attempt:
description: Example response
content:
application/json:
schema:
$ref: '#/components/schemas/Payment-Attempt'
examples:
Example response:
value:
id: psatt_217940156986951680_0X
resource: payment_attempt
amount: 10000
amount_human_readable: '100.00'
currency: usd
created: '2022-09-07T13:40:41.751Z'
customer: cust_222712682678060032
customer_reference_id: 927071e4-464c-4f5d-a079-4aa097f922ca
failure_code: null
failure_message: null
metadata: {}
payment_method: pm_card_202779025452569600
payment_method_details:
type: card
card:
bin: '424242'
brand: visa
country: US
exp_month: '11'
exp_year: '25'
fingerprint: >-
c5338f1c33863cce001e80648ea80df1068ed5f94dbb4bfb561ed8da8988fe0a
funding: credit
last4: '4242'
network: visa
security_checks:
address_line1_check: unavailable
address_postal_code_check: unavailable
cvc_check: pass
three_d_secure: null
token: tok_card_202779025452569600
wallet: null
payment_session: ps_217940156986951680
reference: null
status: succeeded
Payment-Session:
description: Example response
content:
application/json:
schema:
$ref: '#/components/schemas/Payment-Session'
examples:
Example response:
value:
description: null
id: ps_217940156986951680X
resource: payment_session
amount: 10000
amount_human_readable: '''100.00'''
capture: true
charge: null
currency: usd
created: '2022-09-07T13:40:41.751Z'
setup_future_usage: null
customer: cust_222712682678060032
customer_reference_id: 927071e4-464c-4f5d-a079-4aa097f922ca
hold: null
metadata: {}
payment_method: null
payment_method_details: null
payment_method_options:
card:
accepted_card_brands:
- visa
- mastercard
accepted_card_categories:
- consumer
accepted_card_funding:
- debit
- credit
accepted_card_jurisdictions:
- domestic
duplicate_card_check: true
enforce_customer_name_as_cardholder_name: false
security_checks:
address_line1_check: false
address_postal_code_check: false
cvv_check: true
request_threed_secure: challenge
payment_method_types:
- card
reference: null
receipt_email: null
receipt_number: null
receipt_url: null
shipping: null
billing_details: null
statement_descriptor_suffix: TEST
status: open
Setup-Session:
description: Example response
content:
application/json:
schema:
$ref: '#/components/schemas/Setup-Session'
examples:
Example response:
value:
id: ss_217940156986951680X
resource: setup_session
currency: usd
created: '2022-09-07T13:40:41.751Z'
customer: cust_222712682678060032
customer_reference_id: 927071e4-464c-4f5d-a079-4aa097f922ca
client_secret: >-
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJAcGF5LWNvbS9wYXltZW50LWdhdGV3YXkiLCJpYXQiOjE2Mjk2NDczMjYsImV4cCI6MTY2MTE4MzMyNiwiYXVkIjoiaGkiLCJzdWIiOiJ3ZSBsb3ZlIHlvdSA6KSJ9.XK1D0v0XjcNYoQrwOeNPemCEFA6TGuHtGflyiUTtjYs
metadata: {}
payment_method: null
payment_method_details: null
payment_method_options:
card:
accepted_card_brands:
- visa
- mastercard
accepted_card_categories:
- consumer
accepted_card_funding:
- debit
- credit
accepted_card_jurisdictions:
- domestic
duplicate_card_check: true
enforce_customer_name_as_cardholder_name: false
security_checks:
address_line1_check: false
address_postal_code_check: false
cvv_check: true
request_threed_secure: challenge
payment_method_types:
- card
billing_details: null
setup_future_usage: null
status: open
Charge:
description: Example response
content:
application/json:
schema:
$ref: '#/components/schemas/Charge'
examples:
Example response:
value:
description: null
id: chrg_146231656762572800X
resource: charge
amount: 10000
amount_human_readable: '100.00'
amount_refunded: 0
billing_details: null
calculated_statement_descriptor: PAYCOM * TEST
created: '2022-09-07T13:40:41.751Z'
currency: usd
customer: cust_199440887619523584
customer_reference_id: 2s68c46d-8d15-4c2a-ae4c-30ec77abed9f
disputed: false
failure_code: null
failure_message: null
metadata: {}
paid: false
payment_session: null
hold: hld_220204193980350464
payment_method: pm_card_202779025452569600
payment_method_details:
type: card
card:
bin: '424242'
brand: visa
country: US
exp_month: '11'
exp_year: '25'
fingerprint: >-
c5338f1c33863cce001e80648ea80df1068ed5f94dbb4bfb561ed8da8988fe0a
funding: credit
last4: '4242'
network: visa
security_checks:
address_line1_check: unavailable
address_postal_code_check: unavailable
cvc_check: pass
three_d_secure: null
token: tok_card_202779025452569600
wallet: null
payment_method_options:
card:
accepted_card_brands:
- visa
- mastercard
accepted_card_categories:
- consumer
accepted_card_funding:
- debit
- credit
accepted_card_jurisdictions:
- domestic
duplicate_card_check: true
enforce_customer_name_as_cardholder_name: false
security_checks:
address_line1_check: false
address_postal_code_check: false
cvv_check: true
request_threed_secure: challenge
receipt_email: null
receipt_number: null
receipt_url: null
refunded: false
refunds:
data: []
url: /v1/charges/chrg_146231656762572800/refunds
reference: null
shipping: null
statement_descriptor_suffix: TEST
status: succeeded
Hold:
description: Example response
content:
application/json:
schema:
$ref: '#/components/schemas/Hold'
examples:
Example response:
value:
description: null
id: hld_158938670341035008X
resource: hold
amount: 10000
amount_human_readable: '100.00'
amount_capturable: 10000
billing_details: null
created: '2022-09-07T13:40:41.751Z'
currency: usd
canceled: false
canceled_at: null
charges:
data: []
url: /v1/holds/hld_158938670341035008/charges
customer: cust_222779369167260672
customer_reference_id: null
failure_code: null
failure_message: null
metadata: {}
payment_session: null
payment_method: pm_card_202779025452569600
payment_method_details:
type: card
card:
bin: '424242'
brand: visa
country: US
exp_month: '11'
exp_year: '25'
fingerprint: >-
c5338f1c33863cce001e80648ea80df1068ed5f94dbb4bfb561ed8da8988fe0a
funding: credit
last4: '4242'
network: visa
security_checks:
address_line1_check: unavailable
address_postal_code_check: unavailable
cvc_check: pass
three_d_secure: null
token: tok_card_202779025452569600
wallet: null
payment_method_options:
card:
accepted_card_brands:
- visa
- mastercard
accepted_card_categories:
- consumer
accepted_card_funding:
- debit
- credit
accepted_card_jurisdictions:
- domestic
duplicate_card_check: true
enforce_customer_name_as_cardholder_name: false
security_checks:
address_line1_check: false
address_postal_code_check: false
cvv_check: true
request_threed_secure: challenge
reference: null
shipping: null
statement_descriptor_suffix: null
status: requires_capture
Canceled-Hold:
description: Example response
content:
application/json:
schema:
$ref: '#/components/schemas/Hold'
examples:
Example response:
value:
description: null
id: hld_158938670341035008X
resource: hold
amount: 10000
amount_human_readable: '100.00'
amount_capturable: 0
billing_details: null
created: '2022-09-07T13:40:41.751Z'
currency: usd
canceled: true
canceled_at: 1662573940676
charges:
data: []
url: /v1/holds/hld_158938670341035008/charges
customer: cust_222779369167260672
customer_reference_id: null