-
Notifications
You must be signed in to change notification settings - Fork 46
/
schema.graphql
13469 lines (10794 loc) · 386 KB
/
schema.graphql
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
"""Exposes a URL that specifies the behaviour of this scalar."""
directive @specifiedBy(
"""The URL that specifies the behaviour of this scalar."""
url: String!
) on SCALAR
"""Top-level input fields for accepting a dispute."""
input AcceptDisputeInput {
"""
An identifier used to reconcile requests and responses. 255 characters maximum.
"""
clientMutationId: String
"""The ID of the dispute to be accepted."""
disputeId: ID!
}
"""Top-level field returned when accepting a dispute."""
type AcceptDisputePayload {
"""
An identifier used to reconcile requests and responses. 255 characters maximum.
"""
clientMutationId: String
"""Information about the dispute that was accepted."""
dispute: Dispute
}
"""An OAuth access token."""
type AccessToken {
"""The access token."""
accessToken: String
"""The refresh token for getting a new access token."""
refreshToken: String
"""The type of token."""
tokenType: OAuthTokenType
"""Expiration in ISO time format."""
expiresAt: String
}
"""The status of the business account creation request."""
enum AccountCreationStatus {
COMPLETED
DECLINED
IN_SETUP
IN_VETTING
SUBMITTED
}
"""
Input fields for searching for BusinessAccountCreationRequests by their `AccountCreationStatus`.
"""
input AccountCreationStatusSearchInput {
"""The creation status is exactly this value."""
is: AccountCreationStatus
"""The creation status is one of these values."""
in: [AccountCreationStatus!]
}
"""
A NACHA standard entry class (SEC) code, which designates how an ACH transaction was authorized.
"""
enum ACHStandardEntryClassCode {
"""Corporate credit or debit."""
CCD
"""Prearranged payment and deposit."""
PPD
"""Telephone-initiated."""
TEL
"""Internet-initiated/mobile."""
WEB
}
"""
The authentication context class reference that indcates how a universal access token can be used.
"""
enum ACRType {
CLIENT
SERVER
}
"""Representation of an address."""
type Address {
"""Company name."""
company: String
"""The street address."""
streetAddress: String @deprecated(reason: "Use `addressLine1` instead.")
"""
The first line of the street address, such as street number, street name.
"""
addressLine1: String
"""Extended address information, such as an apartment or suite number."""
extendedAddress: String @deprecated(reason: "Use `addressLine2` instead.")
"""
Extended address information, such as an apartment number or suite number.
"""
addressLine2: String
"""First name."""
firstName: String @deprecated(reason: "Use `fullName` instead.")
"""Last name."""
lastName: String @deprecated(reason: "Use `fullName` instead.")
"""Full name."""
fullName: String
"""Locality/city."""
locality: String @deprecated(reason: "Use `adminArea2` instead.")
"""A city, town, or village."""
adminArea2: String
"""State or province."""
region: String @deprecated(reason: "Use `adminArea1` instead.")
"""
Highest level subdivision, such as state, province, or ISO-3166-2 subdivison.
"""
adminArea1: String
"""
Postal code, otherwise known as CAP, CEP, Eircode, NPA, PIN, PLZ, or ZIP code.
"""
postalCode: String
"""Country code for the address."""
countryCode: CountryCode
"""Phone number."""
phoneNumber: String
}
"""Input fields for an Address."""
input AddressInput {
"""Company name. 255 character maximum."""
company: String
"""The street address. 255 character maximum."""
streetAddress: String
"""
The first line of the street address, such as street number, street name. 255 character maximum.
"""
addressLine1: String
"""
Extended address information, such as an apartment or suite number. 255 character maximum.
"""
extendedAddress: String
"""
Extended address information, such as apartment number or suite number. 255 character maximum.
"""
addressLine2: String
"""First name. 255 character maximum."""
firstName: String
"""Last name. 255 character maximum."""
lastName: String
"""Locality/city. 255 character maximum."""
locality: String
"""A city, town or village. 255 character maximum."""
adminArea2: String
"""State or province. 255 character maximum."""
region: String
"""
Highest level subdivision, such as state, province or ISO-3166-2 subdivision. 255 character maximum.
"""
adminArea1: String
"""
Postal code in any country's format, otherwise known as CAP, CEP, Eircode,
NPA, PIN, PLZ, or ZIP code. Nine alphanumeric characters maximum, may also
contain spaces and hyphens.
*Required in the shipping address for Level 3 processing*.
"""
postalCode: String
"""
Country code for the address.
*Required in the shipping address for Level 3 processing*.
"""
countryCode: CountryCode
"""
Deprecated: This field is included for supporting legacy clients. Please use `countryCode` instead.
Country code for the address in ISO 3166-1 alpha-3 format.
"""
countryCodeAlpha3: String
"""
Deprecated: This field is included for supporting legacy clients. Please use `countryCode` instead.
Country code for the address in ISO 3166-1 alpha-2 format.
"""
countryCodeAlpha2: String
"""
Deprecated: This field is included for supporting legacy clients. Please use `countryCode` instead.
Country code for the address in ISO 3166-1 numeric format.
"""
countryCodeNumeric: String
"""
Deprecated: This field is included for supporting legacy clients. Please use `countryCode` instead.
Country name for the address.
"""
countryName: String
}
"""
A monetary amount, either a whole number or a number with exactly two or three decimal places.
"""
scalar Amount
"""
Response codes for name verification if the processor supports the account information inquiry.
"""
enum AniNameResponseCode {
MATCH
NOT_SUPPORTED
NOT_VERIFIED
NO_INPUT
NO_MATCH
PARTIAL_MATCH
RETRY
}
"""Configuration for Apple Pay on iOS."""
type ApplePayConfiguration {
"""The environment being used for Apple Pay."""
status: ApplePayStatus
"""
The country code of the acquiring bank where the transaction is likely to be processed.
"""
countryCode: CountryCodeAlpha2
"""The merchant's Apple Pay currency code."""
currencyCode: CurrencyCodeAlpha
"""
The merchant identifier that must be supplied when making an Apple Pay request.
"""
merchantIdentifier: String
"""A list of card brands supported by the merchant for Apple Pay."""
supportedCardBrands: [CreditCardBrandCode!]
}
"""Additional information about the payment method specific to Apple Pay."""
type ApplePayOriginDetails {
"""
A human-readable description of the Apple Pay payment method. This usually
consists of the Apple Pay card type and its last four digits. If there is no
underlying credit card, this will describe the customer's payment method and
the parent CreditCardDetail object's last4 field will be null.
"""
paymentInstrumentName: String
"""
The first 6 digits of the credit card, known as the Bank Identification
Number. This BIN may differ from the BIN of the customer's actual card.
"""
bin: String
}
"""The environment being used for Apple Pay."""
enum ApplePayStatus {
MOCK
OFF
PRODUCTION
mock
off
production
}
"""Configuration for Apple Pay on web."""
type ApplePayWebConfiguration {
"""The merchant's Apple Pay country code."""
countryCode: CountryCodeAlpha2
"""The merchant's Apple Pay currency code."""
currencyCode: CurrencyCodeAlpha
"""
The merchant identifier that must be supplied when making an Apple Pay request.
"""
merchantIdentifier: String
"""A list of card brands supported by the merchant for Apple Pay."""
supportedCardBrands: [CreditCardBrandCode!]
}
"""The purpose of the merchant application bank account."""
enum ApplicationBankAccountPurpose {
CHECKING
SAVINGS
}
"""The status of a merchant account application."""
enum ApplicationStatus {
APPROVED
PROCESSING
REJECTED
}
"""
Information about the [customer authentication regulation environment](https://developers.braintreepayments.com/guides/3d-secure/migration/javascript/v3#authentication-insight)
that applies to the payment method when processed with the provided merchant account.
"""
type AuthenticationInsight {
"""The merchant account used to determine authentication insight."""
merchantAccountId: String
"""
The customer authentication regulation environment that applies when
transacting with this payment method and merchant account.
"""
customerAuthenticationRegulationEnvironment: CustomerAuthenticationRegulationEnvironment
"""A value indicating when to perform further customer authentication."""
customerAuthenticationIndicator: CustomerAuthenticationIndicator
}
"""
Input fields when requesting authentication insight for a payment method.
"""
input AuthenticationInsightInput {
"""
ID of the merchant account that will be used when charging this payment method.
"""
merchantAccountId: ID!
"""
The intended transaction amount to be authorized on this payment method.
"""
amount: Amount
"""
A flag indicating whether the customer has consented to further recurring transactions.
"""
recurringCustomerConsent: Boolean
"""
The maximum amount permitted for recurring transactions set by the customer.
"""
recurringMaxAmount: Amount
}
"""
Records of authorization adjustments performed when a transaction is captured
for less or more than its original authorization amount.
"""
type AuthorizationAdjustment {
"""
Difference between the authorized amount and the amount captured. Negative
values indicate the authorized amount was adjusted down.
"""
amount: MonetaryAmount
"""Indicates if the adjustment was successful or not."""
successful: Boolean
"""Date and time when this adjustment was performed."""
timestamp: Timestamp
"""Processor response from this adjustment."""
processorResponse: TransactionAuthorizationAdjustmentProcessorResponse
}
"""Accompanying information for an authorization expired transaction."""
type AuthorizationExpiredEvent implements PaymentStatusEvent {
"""The new status of the transaction."""
status: PaymentStatus
"""
Date and time when the authorization for this transaction was marked expired.
"""
timestamp: Timestamp
"""The amount of the transaction for this status event."""
amount: MonetaryAmount
"""The source for the transaction change to the new status."""
source: PaymentSource
"""Whether or not this is the final state for the transaction."""
terminal: Boolean
}
"""
Top-level input fields for creating a transaction by authorizing a credit card.
"""
input AuthorizeCreditCardInput {
"""
An identifier used to reconcile requests and responses. 255 characters maximum.
"""
clientMutationId: String
"""ID of a credit card payment method to be authorized."""
paymentMethodId: ID!
"""Input fields related to the credit card being authorized."""
options: CreditCardTransactionOptionsInput
"""
Input fields for the authorization, with details that will define the resulting transaction.
"""
transaction: TransactionInput!
}
"""Accompanying information for an authorized transaction."""
type AuthorizedEvent implements PaymentStatusEvent {
"""The new status of the transaction."""
status: PaymentStatus
"""Date and time when the transaction was authorized."""
timestamp: Timestamp
"""
The amount the transaction was authorized for. This will match the amount on
the transaction itself. In most cases, you can't request to settle more than this amount.
"""
amount: MonetaryAmount
"""The source for the transaction change to the new status."""
source: PaymentSource
"""
Fields describing the payment processor response to the authorization request.
"""
processorResponse: TransactionAuthorizationProcessorResponse
"""Fields describing the network response to the authorization request."""
networkResponse: PaymentNetworkResponse
"""Risk decision for this transaction."""
riskDecision: RiskDecision
"""Whether or not this is the final state for the transaction."""
terminal: Boolean
"""
The date/time the transaction will expire if it has the authorized status. For
more details on authorization expiration timeframes, see the [Statuses reference](https://developers.braintreepayments.com/reference/general/statuses#authorization-expired).
"""
authorizationExpiresAt: Timestamp
"""
User name of the person who performed an action that triggered the status change of the transaction.
"""
userName: String
}
"""
Top-level input fields for creating a transaction by authorizing a payment method.
"""
input AuthorizePaymentMethodInput {
"""
An identifier used to reconcile requests and responses. 255 characters maximum.
"""
clientMutationId: String
"""ID of a payment method to be authorized."""
paymentMethodId: ID!
"""
Input fields for the authorization, with details that will define the resulting transaction.
"""
transaction: TransactionInput!
}
"""
Top-level input fields for creating a transaction by authorizing a PayPal account.
"""
input AuthorizePayPalAccountInput {
"""
An identifier used to reconcile requests and responses. 255 characters maximum.
"""
clientMutationId: String
"""ID of a PayPal payment method to be authorized."""
paymentMethodId: ID!
"""Input fields related to the PayPal account being authorized."""
options: AuthorizePayPalAccountOptionsInput
"""
Input fields for the authorization, with details that will define the resulting transaction.
"""
transaction: TransactionInput!
}
"""Input fields for authorizing a PayPal account."""
input AuthorizePayPalAccountOptionsInput {
"""
Variable passed directly to PayPal for your own tracking purposes. Customers do not see this value.
"""
customField: String
"""
Description of the transaction that is displayed to customers in PayPal email receipts.
"""
description: String
"""Deprecated: This field is no longer supported."""
payee: PayPalPayeeOptionsInput
}
"""
Top-level input fields for creating a transaction by authorizing a Venmo account.
"""
input AuthorizeVenmoAccountInput {
"""
An identifier used to reconcile requests and responses. 255 characters maximum.
"""
clientMutationId: String
"""ID of a Venmo payment method to be authorized."""
paymentMethodId: ID!
"""Input fields related to the Venmo account being authorized."""
options: AuthorizeVenmoAccountOptionsInput
"""
Input fields for the authorization, with details that will define the resulting transaction.
"""
transaction: TransactionInput!
}
"""Input fields for authorizing a Venmo account."""
input AuthorizeVenmoAccountOptionsInput {
"""Specifies which Venmo business profile to use for the transaction."""
profileId: String
}
"""
Response codes from the processing bank's Address Verification System (AVS) and CVV verification.
"""
enum AvsCvvResponseCode {
"""AVS or CVV checks were skipped via the API."""
BYPASS
DOES_NOT_MATCH
ISSUER_DOES_NOT_PARTICIPATE
MATCHES
NOT_APPLICABLE
NOT_PROVIDED
NOT_VERIFIED
SYSTEM_ERROR
}
"""Information about the credit card based on its BIN."""
type BinRecord {
"""Whether or not the card is prepaid, such as a gift card."""
prepaid: BinRecordValue
"""
Whether the card is designated only to be used for healthcare expenses.
"""
healthcare: BinRecordValue
"""Whether or not the card is a debit card."""
debit: BinRecordValue
"""
Whether the card is regulated by the Durbin Amendment due to the bank's
assets, and therefore has a maximum interchange rate.
"""
durbinRegulated: BinRecordValue
"""
Whether or not the card is a commercial card and capable of processing Level 2 transactions.
"""
commercial: BinRecordValue
"""Whether or not the card is designated for employee wages."""
payroll: BinRecordValue
"""The name of the bank that issued the card."""
issuingBank: String
"""The country code of the country that issued the card."""
countryOfIssuance: CountryCode
"""
A code representing any special program from the card issuer the card is part of.
"""
productId: String
}
"""
A boolean-like value that includes `UNKNOWN` in the case where the information isn't available.
"""
enum BinRecordValue {
NO
UNKNOWN
YES
No
Unknown
Yes
}
"""Configuration for payment methods in legacy clients."""
type BraintreeApiConfiguration {
"""The URL for tokenizing payment methods."""
url: String
"""The authentication for tokenizing payment methods."""
accessToken: String
}
"""Record of onboarding request."""
type BusinessAccountCreationRequest implements Node {
"""Unique identifier generated by PayPal for the onboarding request."""
id: ID!
"""
Information about the merchant account that is being created as a result of the request.
"""
merchantAccount: MerchantAccount
"""The account creation status for this account."""
creationStatus: AccountCreationStatus
"""The completion date and time of the merchant account application."""
completedAt: Timestamp
"""The submitted date and time of the merchant account application."""
submittedAt: Timestamp
}
"""A paginated list of BusinessAccountCreationRequests."""
type BusinessAccountCreationRequestConnection {
"""A list of BusinessAccountCreationRequests."""
edges: [BusinessAccountCreationRequestConnectionEdge]
"""
Information about the page of BusinessAccountCreationRequests contained in `edges`.
"""
pageInfo: PageInfo!
}
"""
A BusinessAccountCreationRequest within a BusinessAccountCreationRequestConnection.
"""
type BusinessAccountCreationRequestConnectionEdge {
"""
This BusinessAccountCreationRequest's location within the
BusinessAccountCreationRequestConnection. Used for requesting additional pages.
"""
cursor: String
"""The business account creation request."""
node: BusinessAccountCreationRequest
}
"""Input fields for searching for BusinessAccountCreationRequests."""
input BusinessAccountCreationRequestSearchInput {
"""Find BusinessAccountCreationRequests with an ID or IDs."""
id: SearchValueInput
"""Find BusinessAccountCreationRequests by their external ID or IDs."""
externalId: SearchValueInput
"""Find BusinessAccountCreationRequests by their creation status."""
status: AccountCreationStatusSearchInput
}
"""The type of the business."""
enum BusinessType {
GOVERNMENT_AGENCY
LIMITED_LIABILITY_CORPORATION
NONPROFIT
PARTNERSHIP
PARTNERSHIP_LLP @deprecated(reason: "No longer applicable, use PARTNERSHIP instead.")
PRIVATE_CORPORATION
PUBLIC_CORPORATION
SOLE_PROPRIETORSHIP
TAX_EXEMPT @deprecated(reason: "No longer applicable, use NONPROFIT instead.")
}
"""Top-level input fields for capturing an authorized transaction."""
input CaptureTransactionInput {
"""
An identifier used to reconcile requests and responses. 255 characters maximum.
"""
clientMutationId: String
"""ID of the transaction to be captured."""
transactionId: ID!
"""
Deprecated: This field is included for supporting legacy clients. Please use `transaction.amount` instead.
The amount to capture on the transaction. Must be greater than 0. You can't
capture more than the authorized amount unless your industry and processor
support settlement adjustment (capturing a certain percentage over the
authorized amount); [contact us for assistance](https://help.braintreepayments.com?issue=TransactionProcessingQuestion).
If you capture an amount that is less than what was authorized, the
transaction object will return the amount captured.
"""
amount: Amount
"""
Input fields for the capture, with details that will define the resulting transaction.
"""
transaction: CaptureTransactionOptionsInput
}
"""
Input fields for a capture, with details that will define the resulting transaction.
"""
input CaptureTransactionOptionsInput {
"""
The amount to capture on the transaction. Must be greater than 0. You can't
capture more than the authorized amount unless your industry and processor
support settlement adjustment (capturing a certain percentage over the
authorized amount); [contact us for assistance](https://help.braintreepayments.com?issue=TransactionProcessingQuestion).
If you capture an amount that is less than what was authorized, the
transaction object will return the amount captured.
"""
amount: Amount
"""
Fields used to define what will appear on a customer's bank statement for a
specific purchase. If specified, this will update the existing descriptor on
the transaction.
"""
descriptor: TransactionDescriptorInput
"""
Discount amount that was included in the total transaction amount. Does not
add to the total amount the payment method will be charged. This value can't
be negative. Please note that this field is not used on PayPal transactions.
*Required for Level 3 processing*.
"""
discountAmount: String
"""
Line items for this transaction. Up to 249 line items may be specified.
*Required for Level 3 processing*.
"""
lineItems: [TransactionLineItemInput!]
"""
Additional information about the transaction. On PayPal transactions, this
field maps to the PayPal invoice number. PayPal invoice numbers must be unique
in your PayPal business account. Maximum 255 characters or 127 for PayPal
transactions. If specified, this will update the existing order ID on the transaction.
"""
orderId: String
"""
A purchase order identification value you associate with this transaction.
*Required for Level 2 processing*.
"""
purchaseOrderNumber: String
"""
Shipping information.
*Required for Level 3 processing*.
"""
shipping: TransactionShippingInput
"""
Tax information about the transaction.
*Required for Level 2 processing*.
"""
tax: TransactionTaxInput
"""
Industry data information. Only one of the three sub-input fields can be provided.
"""
industry: TransactionIndustryInput
}
"""The type of account to be used when transacting with a combo card."""
enum CardAccountType {
CREDIT
DEBIT
}
"""
Additional information about a card present payment method supplied by an in-store payment reader.
"""
type CardPresentOriginDetails implements InStoreReaderOriginDetails {
"""
The authorization mode used to perform the transaction on the payment reader.
"""
authorizationMode: InStoreReaderAuthorizationMode
"""An indicator for whether the transaction was verified via pin."""
pinVerified: Boolean
"""
The input mode used on the payment reader to facilitate an in-store transaction.
"""
inputMode: PaymentReaderInputMode
"""The ID of the terminal that was processed this transaction."""
terminalId: String
}
"""
A list of challenges that are required by the current merchant to process a given credit card.
"""
enum Challenge {
CVV
POSTAL_CODE
cvv
postal_code
}
"""
The chargeback protection level indicates the transaction or dispute's protection status.
"""
enum ChargebackProtectionLevel {
"""
The transaction or dispute is protected by the effortless chargeback protection product.
"""
EFFORTLESS
"""
The merchant has not enrolled any chargeback protection products, or the
merchant is registered, but the transaction or dispute is not protected.
"""
NOT_PROTECTED
"""
The transaction or dispute is protected by the standard chargeback protection product.
"""
STANDARD
}
"""
Top-level input fields for creating a transaction by charging a credit card.
"""
input ChargeCreditCardInput {
"""
An identifier used to reconcile requests and responses. 255 characters maximum.
"""
clientMutationId: String
"""ID of a credit card payment method to be charged."""
paymentMethodId: ID!
"""Input fields for creating a credit card transaction."""
options: CreditCardTransactionOptionsInput
"""
Input fields for the charge, with details that will define the resulting transaction.
"""
transaction: TransactionInput!
}
"""
Top-level input fields for creating a transaction by charging a payment method.
"""
input ChargePaymentMethodInput {
"""
An identifier used to reconcile requests and responses. 255 characters maximum.
"""
clientMutationId: String
"""ID of a payment method to be charged."""
paymentMethodId: ID!
"""
Input fields for the charge, with details that will define the resulting transaction.
"""
transaction: TransactionInput!
}
"""
Top-level input fields for creating a transaction by charging a PayPal account.
"""
input ChargePayPalAccountInput {
"""
An identifier used to reconcile requests and responses. 255 characters maximum.
"""
clientMutationId: String
"""The ID of an existing PayPal account."""
paymentMethodId: ID!
"""Input fields related to the PayPal account being charged."""
options: ChargePayPalAccountOptionsInput
"""
Input fields for the charge, with details that will define the resulting transaction.
"""
transaction: TransactionInput!
}
"""Input fields for creating a transaction with a PayPal account."""
input ChargePayPalAccountOptionsInput {
"""
Variable passed directly to PayPal for your own tracking purposes. Customers do not see this value.
"""
customField: String
"""
Description of the transaction that is displayed to customers in PayPal email receipts.
"""
description: String
"""Deprecated: This field is no longer supported."""
payee: PayPalPayeeOptionsInput
"""Buyer selected PayPal financing option."""
selectedFinancingOption: SelectedPayPalFinancingOptionInput
}
"""
Top-level input fields for creating a transaction by charging a US bank account.
"""
input ChargeUsBankAccountInput {
"""
An identifier used to reconcile requests and responses. 255 characters maximum.
"""
clientMutationId: String
"""The ID of an existing US bank account."""
paymentMethodId: ID!
"""Input fields related to the US bank account being charged."""
options: ChargeUsBankAccountOptionsInput
"""
Input fields for the charge, with details that will define the resulting transaction.
"""
transaction: TransactionInput!
}
"""Input fields for creating a transaction with a US bank account."""
input ChargeUsBankAccountOptionsInput {
"""
A NACHA standard entry class (SEC) code, which designates how the transaction
was authorized. Most internet-based sales should use the `WEB` code.
"""
standardEntryClassCode: ACHStandardEntryClassCode
}
"""
Top-level input fields for creating a transaction by charging a Venmo account.
"""
input ChargeVenmoAccountInput {
"""
An identifier used to reconcile requests and responses. 255 characters maximum.
"""
clientMutationId: String
"""The ID of an existing Venmo account."""
paymentMethodId: ID!
"""Input fields for creating a Pay with Venmo transaction."""
options: ChargeVenmoAccountOptionsInput
"""
Input fields for the charge, with details that will define the resulting transaction.
"""
transaction: TransactionInput!
}
"""Input fields for creating a Pay with Venmo transaction."""
input ChargeVenmoAccountOptionsInput {
"""Specifies which Venmo business profile to use for the transaction."""
profileId: String
}
"""
A partial capture's relationship to its original authorization transaction.