@paynow-gg/typescript-sdk 1.0.17 → 1.0.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -21
- package/README.md +31 -31
- package/dist/generated/management.d.ts +832 -0
- package/dist/generated/management.d.ts.map +1 -1
- package/dist/generated/management.js +16 -0
- package/dist/generated/management.js.map +1 -1
- package/dist/generated/storefront.d.ts +2 -0
- package/dist/generated/storefront.d.ts.map +1 -1
- package/dist/generated/storefront.js.map +1 -1
- package/package.json +28 -28
|
@@ -1067,6 +1067,70 @@ export interface paths {
|
|
|
1067
1067
|
patch?: never;
|
|
1068
1068
|
trace?: never;
|
|
1069
1069
|
};
|
|
1070
|
+
"/v1/stores/{storeId}/payments": {
|
|
1071
|
+
parameters: {
|
|
1072
|
+
query?: never;
|
|
1073
|
+
header?: never;
|
|
1074
|
+
path?: never;
|
|
1075
|
+
cookie?: never;
|
|
1076
|
+
};
|
|
1077
|
+
/**
|
|
1078
|
+
* Get payments
|
|
1079
|
+
* @description Retrieves all payments for the specified store using the filter specified.
|
|
1080
|
+
*/
|
|
1081
|
+
get: operations["Payments_GetPayments"];
|
|
1082
|
+
put?: never;
|
|
1083
|
+
post?: never;
|
|
1084
|
+
delete?: never;
|
|
1085
|
+
options?: never;
|
|
1086
|
+
head?: never;
|
|
1087
|
+
patch?: never;
|
|
1088
|
+
trace?: never;
|
|
1089
|
+
};
|
|
1090
|
+
"/v1/stores/{storeId}/payments/{paymentId}": {
|
|
1091
|
+
parameters: {
|
|
1092
|
+
query?: never;
|
|
1093
|
+
header?: never;
|
|
1094
|
+
path?: never;
|
|
1095
|
+
cookie?: never;
|
|
1096
|
+
};
|
|
1097
|
+
/**
|
|
1098
|
+
* Get payment by ID
|
|
1099
|
+
* @description Retrieves a payment by an ID.
|
|
1100
|
+
*/
|
|
1101
|
+
get: operations["Payments_GetPaymentById"];
|
|
1102
|
+
put?: never;
|
|
1103
|
+
post?: never;
|
|
1104
|
+
delete?: never;
|
|
1105
|
+
options?: never;
|
|
1106
|
+
head?: never;
|
|
1107
|
+
patch?: never;
|
|
1108
|
+
trace?: never;
|
|
1109
|
+
};
|
|
1110
|
+
"/v1/stores/{storeId}/payments/settings": {
|
|
1111
|
+
parameters: {
|
|
1112
|
+
query?: never;
|
|
1113
|
+
header?: never;
|
|
1114
|
+
path?: never;
|
|
1115
|
+
cookie?: never;
|
|
1116
|
+
};
|
|
1117
|
+
/**
|
|
1118
|
+
* Get store payment settings
|
|
1119
|
+
* @description Retrieves payment settings for a store.
|
|
1120
|
+
*/
|
|
1121
|
+
get: operations["Payments_GetStorePaymentSettings"];
|
|
1122
|
+
put?: never;
|
|
1123
|
+
post?: never;
|
|
1124
|
+
delete?: never;
|
|
1125
|
+
options?: never;
|
|
1126
|
+
head?: never;
|
|
1127
|
+
/**
|
|
1128
|
+
* Updates store payment settings
|
|
1129
|
+
* @description Updates payment settings for a store.
|
|
1130
|
+
*/
|
|
1131
|
+
patch: operations["Payments_UpdateStorePaymentSettings"];
|
|
1132
|
+
trace?: never;
|
|
1133
|
+
};
|
|
1070
1134
|
"/v1/stores/{storeId}/products": {
|
|
1071
1135
|
parameters: {
|
|
1072
1136
|
query?: never;
|
|
@@ -1713,6 +1777,19 @@ export interface components {
|
|
|
1713
1777
|
};
|
|
1714
1778
|
/** @enum {string} */
|
|
1715
1779
|
AffiliateLinkRefererType: "invalid" | "first_referer" | "last_referer";
|
|
1780
|
+
/** @description Alipay payment method details */
|
|
1781
|
+
AlipayDetailsDto: {
|
|
1782
|
+
/**
|
|
1783
|
+
* @description The Alipay buyer identifier
|
|
1784
|
+
* @example buyer_abc123
|
|
1785
|
+
*/
|
|
1786
|
+
buyer_id?: string | null;
|
|
1787
|
+
/**
|
|
1788
|
+
* @description A unique fingerprint for this Alipay account
|
|
1789
|
+
* @example fingerprint_xyz789
|
|
1790
|
+
*/
|
|
1791
|
+
fingerprint?: string | null;
|
|
1792
|
+
};
|
|
1716
1793
|
BanDto: {
|
|
1717
1794
|
id: components["schemas"]["FlakeId"];
|
|
1718
1795
|
store_id: components["schemas"]["FlakeId"];
|
|
@@ -1734,6 +1811,119 @@ export interface components {
|
|
|
1734
1811
|
};
|
|
1735
1812
|
/** @enum {string} */
|
|
1736
1813
|
BanType: "unknown" | "steam" | "ip" | "customer" | "customer_name" | "email";
|
|
1814
|
+
/** @description Bancontact payment method details */
|
|
1815
|
+
BancontactDetailsDto: {
|
|
1816
|
+
/**
|
|
1817
|
+
* @description The bank identifier
|
|
1818
|
+
* @example bnp_paribas
|
|
1819
|
+
*/
|
|
1820
|
+
bank?: string | null;
|
|
1821
|
+
/**
|
|
1822
|
+
* @description The bank name
|
|
1823
|
+
* @example BNP Paribas
|
|
1824
|
+
*/
|
|
1825
|
+
bank_name?: string | null;
|
|
1826
|
+
/**
|
|
1827
|
+
* @description The Bank Identifier Code
|
|
1828
|
+
* @example GEBABEBB
|
|
1829
|
+
*/
|
|
1830
|
+
bic?: string | null;
|
|
1831
|
+
/**
|
|
1832
|
+
* @description The last 4 digits of the IBAN
|
|
1833
|
+
* @example 3456
|
|
1834
|
+
*/
|
|
1835
|
+
iban_last4?: string | null;
|
|
1836
|
+
/**
|
|
1837
|
+
* @description The payer name
|
|
1838
|
+
* @example Jean Dupont
|
|
1839
|
+
*/
|
|
1840
|
+
payer_name?: string | null;
|
|
1841
|
+
};
|
|
1842
|
+
/** @description Card payment method details */
|
|
1843
|
+
CardDetailsDto: {
|
|
1844
|
+
/**
|
|
1845
|
+
* @description The card brand
|
|
1846
|
+
* @example visa
|
|
1847
|
+
*/
|
|
1848
|
+
brand: string;
|
|
1849
|
+
/**
|
|
1850
|
+
* @description The country code where the card was issued
|
|
1851
|
+
* @example US
|
|
1852
|
+
*/
|
|
1853
|
+
country: string;
|
|
1854
|
+
/**
|
|
1855
|
+
* Format: int32
|
|
1856
|
+
* @description The card expiration month
|
|
1857
|
+
* @example 12
|
|
1858
|
+
*/
|
|
1859
|
+
exp_month: number;
|
|
1860
|
+
/**
|
|
1861
|
+
* Format: int32
|
|
1862
|
+
* @description The card expiration year
|
|
1863
|
+
* @example 2028
|
|
1864
|
+
*/
|
|
1865
|
+
exp_year: number;
|
|
1866
|
+
/**
|
|
1867
|
+
* @description A unique fingerprint for this card
|
|
1868
|
+
* @example abc123def456
|
|
1869
|
+
*/
|
|
1870
|
+
fingerprint: string;
|
|
1871
|
+
/**
|
|
1872
|
+
* @description The card funding type
|
|
1873
|
+
* @example credit
|
|
1874
|
+
*/
|
|
1875
|
+
funding: string;
|
|
1876
|
+
/**
|
|
1877
|
+
* @description The last 4 digits of the card number
|
|
1878
|
+
* @example 4242
|
|
1879
|
+
*/
|
|
1880
|
+
last4: string;
|
|
1881
|
+
/**
|
|
1882
|
+
* @description The Bank Identification Number (first 6/8 digits of card).
|
|
1883
|
+
* Only available internally.
|
|
1884
|
+
* @example 424242
|
|
1885
|
+
*/
|
|
1886
|
+
bin?: string | null;
|
|
1887
|
+
/**
|
|
1888
|
+
* @description The card issuer/bank name.
|
|
1889
|
+
* Only available internally.
|
|
1890
|
+
* @example Chase Bank
|
|
1891
|
+
*/
|
|
1892
|
+
issuer?: string | null;
|
|
1893
|
+
/**
|
|
1894
|
+
* @description The card description.
|
|
1895
|
+
* Only available internally.
|
|
1896
|
+
* @example Visa Signature
|
|
1897
|
+
*/
|
|
1898
|
+
description?: string | null;
|
|
1899
|
+
wallet?: components["schemas"]["CardWalletDto"];
|
|
1900
|
+
};
|
|
1901
|
+
/** @description Digital wallet details for a card */
|
|
1902
|
+
CardWalletDto: {
|
|
1903
|
+
/**
|
|
1904
|
+
* @description The type of digital wallet
|
|
1905
|
+
* @example apple_pay
|
|
1906
|
+
*/
|
|
1907
|
+
type: string;
|
|
1908
|
+
};
|
|
1909
|
+
/** @description Cash App payment method details */
|
|
1910
|
+
CashAppDetailsDto: {
|
|
1911
|
+
/**
|
|
1912
|
+
* @description The Cash App buyer identifier
|
|
1913
|
+
* @example buyer_abc123
|
|
1914
|
+
*/
|
|
1915
|
+
buyer_id: string;
|
|
1916
|
+
/**
|
|
1917
|
+
* @description The Cash App cashtag
|
|
1918
|
+
* @example $johndoe
|
|
1919
|
+
*/
|
|
1920
|
+
cashtag: string;
|
|
1921
|
+
};
|
|
1922
|
+
/**
|
|
1923
|
+
* @description Defines the type of chargeback coverage provided.
|
|
1924
|
+
* @enum {string}
|
|
1925
|
+
*/
|
|
1926
|
+
ChargebackCoverageTypeDto: "unspecified" | "none" | "fraudulent" | "all";
|
|
1737
1927
|
CheckForBanIDByIdentitiesRequestDto: {
|
|
1738
1928
|
identities: components["schemas"]["BanIdentityDto"][];
|
|
1739
1929
|
};
|
|
@@ -2048,6 +2238,30 @@ export interface components {
|
|
|
2048
2238
|
discord_title?: string | null;
|
|
2049
2239
|
discord_color?: string | null;
|
|
2050
2240
|
};
|
|
2241
|
+
/** @description Cryptocurrency payment method details */
|
|
2242
|
+
CryptoDetailsDto: {
|
|
2243
|
+
/**
|
|
2244
|
+
* @description The cryptocurrency used
|
|
2245
|
+
* @example BTC
|
|
2246
|
+
*/
|
|
2247
|
+
crypto_currency: string;
|
|
2248
|
+
/**
|
|
2249
|
+
* @description The amount in cryptocurrency
|
|
2250
|
+
* @example 0.00150000
|
|
2251
|
+
*/
|
|
2252
|
+
crypto_amount: string;
|
|
2253
|
+
/**
|
|
2254
|
+
* @description The total amount paid in cryptocurrency
|
|
2255
|
+
* @example 0.00150000
|
|
2256
|
+
*/
|
|
2257
|
+
total_paid: string;
|
|
2258
|
+
/**
|
|
2259
|
+
* Format: int32
|
|
2260
|
+
* @description The number of blockchain confirmations
|
|
2261
|
+
* @example 6
|
|
2262
|
+
*/
|
|
2263
|
+
confirmations: number;
|
|
2264
|
+
};
|
|
2051
2265
|
CustomVariableDto: {
|
|
2052
2266
|
id: components["schemas"]["FlakeId"];
|
|
2053
2267
|
store_id: components["schemas"]["FlakeId"];
|
|
@@ -2579,6 +2793,29 @@ export interface components {
|
|
|
2579
2793
|
updated_at?: string | null;
|
|
2580
2794
|
updated_by?: components["schemas"]["ActorDto"];
|
|
2581
2795
|
};
|
|
2796
|
+
/** @description iDEAL payment method details */
|
|
2797
|
+
IdealDetailsDto: {
|
|
2798
|
+
/**
|
|
2799
|
+
* @description The bank identifier
|
|
2800
|
+
* @example abn_amro
|
|
2801
|
+
*/
|
|
2802
|
+
bank: string;
|
|
2803
|
+
/**
|
|
2804
|
+
* @description The Bank Identifier Code
|
|
2805
|
+
* @example ABNANL2A
|
|
2806
|
+
*/
|
|
2807
|
+
bic: string;
|
|
2808
|
+
/**
|
|
2809
|
+
* @description The last 4 digits of the IBAN
|
|
2810
|
+
* @example 1234
|
|
2811
|
+
*/
|
|
2812
|
+
iban_last4?: string | null;
|
|
2813
|
+
/**
|
|
2814
|
+
* @description The payer name
|
|
2815
|
+
* @example John Doe
|
|
2816
|
+
*/
|
|
2817
|
+
payer_name?: string | null;
|
|
2818
|
+
};
|
|
2582
2819
|
/** @description Optional inline product definition for dynamic products.
|
|
2583
2820
|
* Requires special approval, use `product_id` instead. */
|
|
2584
2821
|
InlineProductCreateDto: {
|
|
@@ -2662,12 +2899,33 @@ export interface components {
|
|
|
2662
2899
|
/** @description The IDs of associated custom variables. */
|
|
2663
2900
|
custom_variable_ids?: components["schemas"]["FlakeId"][] | null;
|
|
2664
2901
|
};
|
|
2902
|
+
/** @description Klarna payment method details */
|
|
2903
|
+
KlarnaDetailsDto: {
|
|
2904
|
+
/**
|
|
2905
|
+
* @description The country code
|
|
2906
|
+
* @example SE
|
|
2907
|
+
*/
|
|
2908
|
+
country?: string | null;
|
|
2909
|
+
/**
|
|
2910
|
+
* @description The Klarna payment method category
|
|
2911
|
+
* @example pay_later
|
|
2912
|
+
*/
|
|
2913
|
+
method_category?: string | null;
|
|
2914
|
+
};
|
|
2665
2915
|
/** @description The last payment decline object. */
|
|
2666
2916
|
LastPaymentErrorDto: {
|
|
2667
2917
|
decline_code: components["schemas"]["PaymentDeclineCode"];
|
|
2668
2918
|
/** @description Human-readable decline reason message. */
|
|
2669
2919
|
message: string;
|
|
2670
2920
|
};
|
|
2921
|
+
/** @description Link payment method details */
|
|
2922
|
+
LinkDetailsDto: {
|
|
2923
|
+
/**
|
|
2924
|
+
* @description The email associated with the Link account
|
|
2925
|
+
* @example john.doe@example.com
|
|
2926
|
+
*/
|
|
2927
|
+
email: string;
|
|
2928
|
+
};
|
|
2671
2929
|
/** @description Represents the configuration settings for a coupon applied to marketing features. */
|
|
2672
2930
|
MarketingCouponConfigurationDto: {
|
|
2673
2931
|
duration: components["schemas"]["CouponDurationEnum"];
|
|
@@ -3007,6 +3265,42 @@ export interface components {
|
|
|
3007
3265
|
* @enum {string}
|
|
3008
3266
|
*/
|
|
3009
3267
|
OrderType: "one_time" | "subscription" | "mixed";
|
|
3268
|
+
/** @description Przelewy24 payment method details */
|
|
3269
|
+
P24DetailsDto: {
|
|
3270
|
+
/**
|
|
3271
|
+
* @description The bank identifier
|
|
3272
|
+
* @example ing
|
|
3273
|
+
*/
|
|
3274
|
+
bank: string;
|
|
3275
|
+
/**
|
|
3276
|
+
* @description The payer name
|
|
3277
|
+
* @example Jan Kowalski
|
|
3278
|
+
*/
|
|
3279
|
+
payer_name?: string | null;
|
|
3280
|
+
};
|
|
3281
|
+
/** @description Pay by Bank payment method details */
|
|
3282
|
+
PayByBankDetailsDto: {
|
|
3283
|
+
/**
|
|
3284
|
+
* @description The bank name
|
|
3285
|
+
* @example Chase Bank
|
|
3286
|
+
*/
|
|
3287
|
+
bank_name?: string | null;
|
|
3288
|
+
/**
|
|
3289
|
+
* @description The Bank Identifier Code
|
|
3290
|
+
* @example CHASUS33
|
|
3291
|
+
*/
|
|
3292
|
+
bic?: string | null;
|
|
3293
|
+
/**
|
|
3294
|
+
* @description The country code
|
|
3295
|
+
* @example US
|
|
3296
|
+
*/
|
|
3297
|
+
country?: string | null;
|
|
3298
|
+
/**
|
|
3299
|
+
* @description The payer name
|
|
3300
|
+
* @example John Smith
|
|
3301
|
+
*/
|
|
3302
|
+
payer_name?: string | null;
|
|
3303
|
+
};
|
|
3010
3304
|
/** @enum {string} */
|
|
3011
3305
|
PayNowActorType: "anonymous" | "user" | "customer" | "api_key" | "game_server" | "admin" | "internal" | "platform" | "global_customer";
|
|
3012
3306
|
/** @description Represents a PayNow error */
|
|
@@ -3035,17 +3329,345 @@ export interface components {
|
|
|
3035
3329
|
/** @description An array of multiple errors. Only used by some API services. */
|
|
3036
3330
|
errors?: components["schemas"]["ValidationError"][] | null;
|
|
3037
3331
|
};
|
|
3332
|
+
/** @description PayPal payment method details */
|
|
3333
|
+
PayPalDetailsDto: {
|
|
3334
|
+
/**
|
|
3335
|
+
* @description The PayPal payer identifier
|
|
3336
|
+
* @example PAYERID123
|
|
3337
|
+
*/
|
|
3338
|
+
payer_id: string;
|
|
3339
|
+
/**
|
|
3340
|
+
* @description The PayPal account email
|
|
3341
|
+
* @example john.doe@example.com
|
|
3342
|
+
*/
|
|
3343
|
+
payer_email: string;
|
|
3344
|
+
/**
|
|
3345
|
+
* @description The PayPal account holder name
|
|
3346
|
+
* @example John Doe
|
|
3347
|
+
*/
|
|
3348
|
+
payer_name: string;
|
|
3349
|
+
/**
|
|
3350
|
+
* @description The country code of the PayPal account
|
|
3351
|
+
* @example US
|
|
3352
|
+
*/
|
|
3353
|
+
country: string;
|
|
3354
|
+
/**
|
|
3355
|
+
* @description Indicates if this PayPal account is vaulted
|
|
3356
|
+
* @example true
|
|
3357
|
+
*/
|
|
3358
|
+
vault: boolean;
|
|
3359
|
+
/**
|
|
3360
|
+
* @description Indicates if vault approval is pending
|
|
3361
|
+
* @example false
|
|
3362
|
+
*/
|
|
3363
|
+
pending_vault_approval?: boolean | null;
|
|
3364
|
+
/**
|
|
3365
|
+
* @description Indicates if this is a standalone setup
|
|
3366
|
+
* @example false
|
|
3367
|
+
*/
|
|
3368
|
+
standalone_setup?: boolean | null;
|
|
3369
|
+
};
|
|
3370
|
+
/**
|
|
3371
|
+
* @description Represents chargeback status of a payment
|
|
3372
|
+
* @enum {string}
|
|
3373
|
+
*/
|
|
3374
|
+
PaymentChargebackStatusDto: "none" | "pending" | "won" | "lost";
|
|
3038
3375
|
/**
|
|
3039
3376
|
* @description A payment decline reason code.
|
|
3040
3377
|
* @enum {string}
|
|
3041
3378
|
*/
|
|
3042
3379
|
PaymentDeclineCode: "unknown" | "generic_decline" | "call_issuer" | "authentication_required" | "currency_not_supported" | "duplicate_transaction" | "expired_card" | "fraudulent" | "incorrect_number" | "incorrect_cvc" | "incorrect_pin" | "incorrect_zip" | "insufficient_funds" | "invalid_account" | "invalid_amount" | "invalid_expiry_month" | "invalid_expiry_year" | "issuer_not_available" | "lost_card" | "merchant_blacklist" | "new_account_information_available" | "no_action_taken" | "pickup_card" | "pin_try_exceeded" | "restricted_card" | "stolen_card" | "testmode_decline" | "try_again_later" | "security_violation" | "card_velocity_exceeded" | "do_not_honor" | "processing_error" | "card_not_supported" | "transaction_not_allowed" | "authorization_revoked";
|
|
3380
|
+
/** @description Represents a payment transaction */
|
|
3381
|
+
PaymentDto: {
|
|
3382
|
+
id: components["schemas"]["FlakeId"];
|
|
3383
|
+
store_id: components["schemas"]["FlakeId"];
|
|
3384
|
+
order_id: components["schemas"]["FlakeId"];
|
|
3385
|
+
customer_id: components["schemas"]["FlakeId"];
|
|
3386
|
+
customer: components["schemas"]["CustomerDto"];
|
|
3387
|
+
/** @description The list of refunds associated with this payment */
|
|
3388
|
+
refunds?: components["schemas"]["RefundDto"][] | null;
|
|
3389
|
+
/**
|
|
3390
|
+
* @description The payment gateway provider
|
|
3391
|
+
* @example stripe
|
|
3392
|
+
*/
|
|
3393
|
+
gateway: string;
|
|
3394
|
+
/** @description The gateway entity identifier */
|
|
3395
|
+
gateway_entity_identifier: string;
|
|
3396
|
+
/** @description The gateway payment identifier */
|
|
3397
|
+
gateway_id: string;
|
|
3398
|
+
method: components["schemas"]["PaymentMethodDto"];
|
|
3399
|
+
method_id?: components["schemas"]["FlakeId"];
|
|
3400
|
+
status: components["schemas"]["PaymentStatusDto"];
|
|
3401
|
+
/**
|
|
3402
|
+
* @description The currency code used for this payment in the store's currency
|
|
3403
|
+
* @example usd
|
|
3404
|
+
*/
|
|
3405
|
+
currency: string;
|
|
3406
|
+
/**
|
|
3407
|
+
* Format: int32
|
|
3408
|
+
* @description The total payment amount in smallest currency unit
|
|
3409
|
+
* @example 10000
|
|
3410
|
+
*/
|
|
3411
|
+
amount: number;
|
|
3412
|
+
/**
|
|
3413
|
+
* Format: int32
|
|
3414
|
+
* @description The gateway fee amount in smallest currency unit
|
|
3415
|
+
* @example 320
|
|
3416
|
+
*/
|
|
3417
|
+
gateway_fee_amount: number;
|
|
3418
|
+
/**
|
|
3419
|
+
* Format: int32
|
|
3420
|
+
* @description The tax amount in smallest currency unit
|
|
3421
|
+
* @example 850
|
|
3422
|
+
*/
|
|
3423
|
+
tax_amount: number;
|
|
3424
|
+
/**
|
|
3425
|
+
* Format: int32
|
|
3426
|
+
* @description The platform fee amount in smallest currency unit
|
|
3427
|
+
* @example 500
|
|
3428
|
+
*/
|
|
3429
|
+
platform_fee_amount: number;
|
|
3430
|
+
/**
|
|
3431
|
+
* Format: int32
|
|
3432
|
+
* @description The net amount going to the store in smallest currency unit
|
|
3433
|
+
* @example 8330
|
|
3434
|
+
*/
|
|
3435
|
+
store_net_amount: number;
|
|
3436
|
+
/**
|
|
3437
|
+
* @description The currency code used for presentment to the customer
|
|
3438
|
+
* @example eur
|
|
3439
|
+
*/
|
|
3440
|
+
presentment_currency: string;
|
|
3441
|
+
/**
|
|
3442
|
+
* Format: int32
|
|
3443
|
+
* @description The amount presented to the customer in smallest currency unit
|
|
3444
|
+
* @example 9500
|
|
3445
|
+
*/
|
|
3446
|
+
presentment_amount: number;
|
|
3447
|
+
/**
|
|
3448
|
+
* Format: double
|
|
3449
|
+
* @description The foreign exchange rate used for currency conversion
|
|
3450
|
+
* @example 1.085
|
|
3451
|
+
*/
|
|
3452
|
+
fx_rate?: number | null;
|
|
3453
|
+
/**
|
|
3454
|
+
* Format: int32
|
|
3455
|
+
* @description The platform fee rate applied to this payment (in basis points)
|
|
3456
|
+
* @example 500
|
|
3457
|
+
*/
|
|
3458
|
+
platform_fee_rate: number;
|
|
3459
|
+
chargeback_status: components["schemas"]["PaymentChargebackStatusDto"];
|
|
3460
|
+
/**
|
|
3461
|
+
* Format: date-time
|
|
3462
|
+
* @description The date and time when the chargeback status was last updated
|
|
3463
|
+
* @example null
|
|
3464
|
+
*/
|
|
3465
|
+
chargeback_status_updated_at?: string | null;
|
|
3466
|
+
/** @description The payout split rules for multi-party payments */
|
|
3467
|
+
payout_split_rules?: components["schemas"]["PaymentPayoutSplitRuleDto"][] | null;
|
|
3468
|
+
/** @description The payout split results for multi-party payments */
|
|
3469
|
+
payout_split_results?: components["schemas"]["PaymentPayoutSplitResultDto"][] | null;
|
|
3470
|
+
/**
|
|
3471
|
+
* Format: date-time
|
|
3472
|
+
* @description The date and time when this payment was created
|
|
3473
|
+
* @example 2025-04-01T15:30:45Z
|
|
3474
|
+
*/
|
|
3475
|
+
created_at: string;
|
|
3476
|
+
/**
|
|
3477
|
+
* Format: date-time
|
|
3478
|
+
* @description The date and time when this payment entered pending status
|
|
3479
|
+
* @example 2025-04-01T15:30:46Z
|
|
3480
|
+
*/
|
|
3481
|
+
pending_at?: string | null;
|
|
3482
|
+
/**
|
|
3483
|
+
* Format: date-time
|
|
3484
|
+
* @description The date and time when this payment was completed
|
|
3485
|
+
* @example 2025-04-01T15:31:12Z
|
|
3486
|
+
*/
|
|
3487
|
+
completed_at?: string | null;
|
|
3488
|
+
/**
|
|
3489
|
+
* Format: date-time
|
|
3490
|
+
* @description The date and time when this payment was canceled
|
|
3491
|
+
* @example null
|
|
3492
|
+
*/
|
|
3493
|
+
canceled_at?: string | null;
|
|
3494
|
+
/**
|
|
3495
|
+
* Format: date-time
|
|
3496
|
+
* @description The date and time when this payment failed
|
|
3497
|
+
* @example null
|
|
3498
|
+
*/
|
|
3499
|
+
failed_at?: string | null;
|
|
3500
|
+
/**
|
|
3501
|
+
* Format: date-time
|
|
3502
|
+
* @description The date and time when this payment was last refunded
|
|
3503
|
+
* @example null
|
|
3504
|
+
*/
|
|
3505
|
+
refunded_at?: string | null;
|
|
3506
|
+
/**
|
|
3507
|
+
* Format: date-time
|
|
3508
|
+
* @description The date and time when a chargeback was initiated on this payment
|
|
3509
|
+
* @example null
|
|
3510
|
+
*/
|
|
3511
|
+
chargeback_at?: string | null;
|
|
3512
|
+
last_payment_error?: components["schemas"]["LastPaymentErrorDto"];
|
|
3513
|
+
};
|
|
3514
|
+
/** @description Contains detailed information about a payment method.
|
|
3515
|
+
* DISCLAIMER: These fields are not guaranteed to be backwards compatible and may change or be removed without notice. */
|
|
3516
|
+
PaymentMethodDetailsDto: {
|
|
3517
|
+
card?: components["schemas"]["CardDetailsDto"];
|
|
3518
|
+
cashapp?: components["schemas"]["CashAppDetailsDto"];
|
|
3519
|
+
paypal?: components["schemas"]["PayPalDetailsDto"];
|
|
3520
|
+
link?: components["schemas"]["LinkDetailsDto"];
|
|
3521
|
+
crypto?: components["schemas"]["CryptoDetailsDto"];
|
|
3522
|
+
steamskins?: components["schemas"]["SteamSkinsDetailsDto"];
|
|
3523
|
+
ideal?: components["schemas"]["IdealDetailsDto"];
|
|
3524
|
+
p24?: components["schemas"]["P24DetailsDto"];
|
|
3525
|
+
bancontact?: components["schemas"]["BancontactDetailsDto"];
|
|
3526
|
+
klarna?: components["schemas"]["KlarnaDetailsDto"];
|
|
3527
|
+
alipay?: components["schemas"]["AlipayDetailsDto"];
|
|
3528
|
+
pay_by_bank?: components["schemas"]["PayByBankDetailsDto"];
|
|
3529
|
+
pix?: components["schemas"]["PixDetailsDto"];
|
|
3530
|
+
};
|
|
3531
|
+
/** @description Represents a stored payment method */
|
|
3532
|
+
PaymentMethodDto: {
|
|
3533
|
+
id: components["schemas"]["FlakeId"];
|
|
3534
|
+
customer_id: components["schemas"]["FlakeId"];
|
|
3535
|
+
/** @description The payment gateway provider */
|
|
3536
|
+
gateway: string;
|
|
3537
|
+
/** @description The gateway's identifier for this payment method */
|
|
3538
|
+
gateway_id: string;
|
|
3539
|
+
/** @description The gateway's customer identifier */
|
|
3540
|
+
gateway_customer_id: string;
|
|
3541
|
+
/**
|
|
3542
|
+
* @description The gateway-specific type identifier
|
|
3543
|
+
* @example card
|
|
3544
|
+
*/
|
|
3545
|
+
gateway_type: string;
|
|
3546
|
+
/**
|
|
3547
|
+
* @description The payment method type
|
|
3548
|
+
* @example card
|
|
3549
|
+
*/
|
|
3550
|
+
method_type: string;
|
|
3551
|
+
method_details: components["schemas"]["PaymentMethodDetailsDto"];
|
|
3552
|
+
/**
|
|
3553
|
+
* Format: date-time
|
|
3554
|
+
* @description The date and time when this payment method was created
|
|
3555
|
+
* @example 2025-03-15T10:20:30Z
|
|
3556
|
+
*/
|
|
3557
|
+
created_at: string;
|
|
3558
|
+
/** @description The gateway entity identifier */
|
|
3559
|
+
gateway_entity_identifier: string;
|
|
3560
|
+
/**
|
|
3561
|
+
* Format: date-time
|
|
3562
|
+
* @description The date and time when this payment method was last updated
|
|
3563
|
+
* @example 2025-03-20T14:30:00Z
|
|
3564
|
+
*/
|
|
3565
|
+
updated_at?: string | null;
|
|
3566
|
+
};
|
|
3567
|
+
/** @description Represents payout split results for multi-party payments */
|
|
3568
|
+
PaymentPayoutSplitResultDto: {
|
|
3569
|
+
user_id: components["schemas"]["FlakeId"];
|
|
3570
|
+
/**
|
|
3571
|
+
* Format: int32
|
|
3572
|
+
* @description The gross amount before fees in smallest currency unit
|
|
3573
|
+
* @example 10000
|
|
3574
|
+
*/
|
|
3575
|
+
gross_amount: number;
|
|
3576
|
+
/**
|
|
3577
|
+
* Format: int32
|
|
3578
|
+
* @description The tax amount in smallest currency unit
|
|
3579
|
+
* @example 850
|
|
3580
|
+
*/
|
|
3581
|
+
tax_amount: number;
|
|
3582
|
+
/**
|
|
3583
|
+
* Format: int32
|
|
3584
|
+
* @description The gateway fee amount in smallest currency unit
|
|
3585
|
+
* @example 320
|
|
3586
|
+
*/
|
|
3587
|
+
gateway_fee_amount: number;
|
|
3588
|
+
/**
|
|
3589
|
+
* Format: int32
|
|
3590
|
+
* @description The platform fee amount in smallest currency unit
|
|
3591
|
+
* @example 500
|
|
3592
|
+
*/
|
|
3593
|
+
platform_fee_amount: number;
|
|
3594
|
+
/**
|
|
3595
|
+
* Format: int32
|
|
3596
|
+
* @description The connected platform fee amount in smallest currency unit
|
|
3597
|
+
* @example 100
|
|
3598
|
+
*/
|
|
3599
|
+
connected_platform_fee_amount: number;
|
|
3600
|
+
/**
|
|
3601
|
+
* Format: int32
|
|
3602
|
+
* @description The net amount after all fees in smallest currency unit
|
|
3603
|
+
* @example 8230
|
|
3604
|
+
*/
|
|
3605
|
+
net_amount: number;
|
|
3606
|
+
line_id: components["schemas"]["FlakeId"];
|
|
3607
|
+
};
|
|
3608
|
+
/** @description Represents payout split rules for a payment line */
|
|
3609
|
+
PaymentPayoutSplitRuleDto: {
|
|
3610
|
+
line_id: components["schemas"]["FlakeId"];
|
|
3611
|
+
/**
|
|
3612
|
+
* Format: int32
|
|
3613
|
+
* @description The total amount of the line item in smallest currency unit
|
|
3614
|
+
* @example 10000
|
|
3615
|
+
*/
|
|
3616
|
+
line_amount_total: number;
|
|
3617
|
+
/**
|
|
3618
|
+
* Format: int32
|
|
3619
|
+
* @description The tax amount of the line item in smallest currency unit
|
|
3620
|
+
* @example 850
|
|
3621
|
+
*/
|
|
3622
|
+
line_amount_tax: number;
|
|
3623
|
+
/** @description The list of splits defining how the payout should be divided */
|
|
3624
|
+
splits: components["schemas"]["PaymentPayoutSplitRuleSplitDto"][];
|
|
3625
|
+
};
|
|
3626
|
+
/** @description Represents a single split configuration within a payout split rule */
|
|
3627
|
+
PaymentPayoutSplitRuleSplitDto: {
|
|
3628
|
+
user_id: components["schemas"]["FlakeId"];
|
|
3629
|
+
/**
|
|
3630
|
+
* Format: int32
|
|
3631
|
+
* @description The percentage of the line amount this user receives (in basis points, e.g., 5000 = 50%)
|
|
3632
|
+
* @example 5000
|
|
3633
|
+
*/
|
|
3634
|
+
percentage?: number | null;
|
|
3635
|
+
/**
|
|
3636
|
+
* Format: int32
|
|
3637
|
+
* @description The platform fee percentage applied to this split (in basis points)
|
|
3638
|
+
* @example 500
|
|
3639
|
+
*/
|
|
3640
|
+
platform_fee_percentage: number;
|
|
3641
|
+
};
|
|
3642
|
+
/**
|
|
3643
|
+
* @description Represents payment status
|
|
3644
|
+
* @enum {string}
|
|
3645
|
+
*/
|
|
3646
|
+
PaymentStatusDto: "unknown" | "created" | "pending" | "completed" | "canceled" | "failed" | "refunded" | "chargeback" | "refund_failed" | "refund_processing";
|
|
3043
3647
|
/**
|
|
3044
3648
|
* Format: period
|
|
3045
3649
|
* @description ISO 8601 duration format
|
|
3046
3650
|
* @example P1Y2M3DT4H5M6S
|
|
3047
3651
|
*/
|
|
3048
3652
|
Period: string;
|
|
3653
|
+
/** @description Pix payment method details */
|
|
3654
|
+
PixDetailsDto: {
|
|
3655
|
+
/**
|
|
3656
|
+
* @description The bank name
|
|
3657
|
+
* @example Banco do Brasil
|
|
3658
|
+
*/
|
|
3659
|
+
bank_name?: string | null;
|
|
3660
|
+
/**
|
|
3661
|
+
* @description The bank account number
|
|
3662
|
+
* @example 12345-6
|
|
3663
|
+
*/
|
|
3664
|
+
bank_account_number?: string | null;
|
|
3665
|
+
/**
|
|
3666
|
+
* @description The payer name
|
|
3667
|
+
* @example João Silva
|
|
3668
|
+
*/
|
|
3669
|
+
payer_name?: string | null;
|
|
3670
|
+
};
|
|
3049
3671
|
ProductCommandDto: {
|
|
3050
3672
|
stage: components["schemas"]["ProductCommandStage"];
|
|
3051
3673
|
/** @description Content of the command. */
|
|
@@ -3689,6 +4311,52 @@ export interface components {
|
|
|
3689
4311
|
/** @description The URL to the user's Steam avatar image. */
|
|
3690
4312
|
avatar_url: string;
|
|
3691
4313
|
};
|
|
4314
|
+
/** @description Steam Skins payment method details */
|
|
4315
|
+
SteamSkinsDetailsDto: {
|
|
4316
|
+
/** @description The list of Steam inventory items used for payment */
|
|
4317
|
+
items: components["schemas"]["SteamSkinsInventoryItemDetailsDto"][];
|
|
4318
|
+
};
|
|
4319
|
+
SteamSkinsInventoryItemDetailsDto: {
|
|
4320
|
+
/** @description The unique identifier of the Steam item */
|
|
4321
|
+
id: string;
|
|
4322
|
+
/**
|
|
4323
|
+
* Format: int32
|
|
4324
|
+
* @description The Steam app ID
|
|
4325
|
+
* @example 730
|
|
4326
|
+
*/
|
|
4327
|
+
app_id: number;
|
|
4328
|
+
/**
|
|
4329
|
+
* @description The name of the item
|
|
4330
|
+
* @example AK-47 | Redline
|
|
4331
|
+
*/
|
|
4332
|
+
name: string;
|
|
4333
|
+
/**
|
|
4334
|
+
* Format: int32
|
|
4335
|
+
* @description The price of the item in the smallest currency unit
|
|
4336
|
+
* @example 2500
|
|
4337
|
+
*/
|
|
4338
|
+
price: number;
|
|
4339
|
+
};
|
|
4340
|
+
/** @description Store payment configuration settings. */
|
|
4341
|
+
StorePaymentSettingsDto: {
|
|
4342
|
+
/** @description Whether to show all available payment methods for subscription purchases. */
|
|
4343
|
+
show_all_payment_methods_for_subscriptions: boolean;
|
|
4344
|
+
/** @description Whether store pricing is tax-inclusive. */
|
|
4345
|
+
store_tax_inclusive_pricing: boolean;
|
|
4346
|
+
/**
|
|
4347
|
+
* Format: int64
|
|
4348
|
+
* @description Maximum checkout amount allowed in cents.
|
|
4349
|
+
*/
|
|
4350
|
+
max_checkout_amount: number;
|
|
4351
|
+
/** @description Whether to force 3D Secure authentication for all transactions. */
|
|
4352
|
+
force_3d_secure: boolean;
|
|
4353
|
+
chargeback_coverage: components["schemas"]["ChargebackCoverageTypeDto"];
|
|
4354
|
+
/**
|
|
4355
|
+
* Format: int64
|
|
4356
|
+
* @description Maximum per-transaction chargeback coverage amount in cents.
|
|
4357
|
+
*/
|
|
4358
|
+
chargeback_coverage_max_amount?: number | null;
|
|
4359
|
+
};
|
|
3692
4360
|
StorePricingRegionOverrideDto: {
|
|
3693
4361
|
/** Format: int64 */
|
|
3694
4362
|
default_price_multiplier?: number | null;
|
|
@@ -3716,6 +4384,7 @@ export interface components {
|
|
|
3716
4384
|
store_id: components["schemas"]["FlakeId"];
|
|
3717
4385
|
customer: components["schemas"]["CustomerDto"];
|
|
3718
4386
|
payment_method_id?: components["schemas"]["FlakeId"];
|
|
4387
|
+
payment_method?: components["schemas"]["PaymentMethodDto"];
|
|
3719
4388
|
status: components["schemas"]["SubscriptionStatus"];
|
|
3720
4389
|
coupon_id?: components["schemas"]["FlakeId"];
|
|
3721
4390
|
/**
|
|
@@ -7479,6 +8148,153 @@ export interface operations {
|
|
|
7479
8148
|
};
|
|
7480
8149
|
};
|
|
7481
8150
|
};
|
|
8151
|
+
Payments_GetPayments: {
|
|
8152
|
+
parameters: {
|
|
8153
|
+
query?: {
|
|
8154
|
+
/** @description The maximum number of items to return in a single request. */
|
|
8155
|
+
limit?: number;
|
|
8156
|
+
/**
|
|
8157
|
+
* @description Returns items after the specified ID.
|
|
8158
|
+
* Used for forward pagination through results.
|
|
8159
|
+
* @example null
|
|
8160
|
+
*/
|
|
8161
|
+
after?: components["schemas"]["FlakeId"];
|
|
8162
|
+
/**
|
|
8163
|
+
* @description Returns items before the specified ID.
|
|
8164
|
+
* Used for backward pagination through results.
|
|
8165
|
+
* @example null
|
|
8166
|
+
*/
|
|
8167
|
+
before?: components["schemas"]["FlakeId"];
|
|
8168
|
+
/** @description Determines the sort order of returned items.
|
|
8169
|
+
* When true, items are returned in ascending order.
|
|
8170
|
+
* When false, items are returned in descending order. */
|
|
8171
|
+
asc?: boolean;
|
|
8172
|
+
/** @description Filter by payment statuses */
|
|
8173
|
+
status?: components["schemas"]["PaymentStatusDto"][];
|
|
8174
|
+
/** @description Filter by order ID */
|
|
8175
|
+
order_id?: components["schemas"]["FlakeId"];
|
|
8176
|
+
/** @description Filter by customer ID */
|
|
8177
|
+
customer_id?: components["schemas"]["FlakeId"];
|
|
8178
|
+
};
|
|
8179
|
+
header?: never;
|
|
8180
|
+
path?: never;
|
|
8181
|
+
cookie?: never;
|
|
8182
|
+
};
|
|
8183
|
+
requestBody?: never;
|
|
8184
|
+
responses: {
|
|
8185
|
+
/** @description OK */
|
|
8186
|
+
200: {
|
|
8187
|
+
headers: {
|
|
8188
|
+
[name: string]: unknown;
|
|
8189
|
+
};
|
|
8190
|
+
content: {
|
|
8191
|
+
"application/json": components["schemas"]["PaymentDto"][];
|
|
8192
|
+
};
|
|
8193
|
+
};
|
|
8194
|
+
/** @description Error response */
|
|
8195
|
+
default: {
|
|
8196
|
+
headers: {
|
|
8197
|
+
[name: string]: unknown;
|
|
8198
|
+
};
|
|
8199
|
+
content: {
|
|
8200
|
+
"application/json": components["schemas"]["PayNowError"];
|
|
8201
|
+
};
|
|
8202
|
+
};
|
|
8203
|
+
};
|
|
8204
|
+
};
|
|
8205
|
+
Payments_GetPaymentById: {
|
|
8206
|
+
parameters: {
|
|
8207
|
+
query?: never;
|
|
8208
|
+
header?: never;
|
|
8209
|
+
path: {
|
|
8210
|
+
paymentId: components["schemas"]["FlakeId"];
|
|
8211
|
+
};
|
|
8212
|
+
cookie?: never;
|
|
8213
|
+
};
|
|
8214
|
+
requestBody?: never;
|
|
8215
|
+
responses: {
|
|
8216
|
+
/** @description OK */
|
|
8217
|
+
200: {
|
|
8218
|
+
headers: {
|
|
8219
|
+
[name: string]: unknown;
|
|
8220
|
+
};
|
|
8221
|
+
content: {
|
|
8222
|
+
"application/json": components["schemas"]["PaymentDto"];
|
|
8223
|
+
};
|
|
8224
|
+
};
|
|
8225
|
+
/** @description Error response */
|
|
8226
|
+
default: {
|
|
8227
|
+
headers: {
|
|
8228
|
+
[name: string]: unknown;
|
|
8229
|
+
};
|
|
8230
|
+
content: {
|
|
8231
|
+
"application/json": components["schemas"]["PayNowError"];
|
|
8232
|
+
};
|
|
8233
|
+
};
|
|
8234
|
+
};
|
|
8235
|
+
};
|
|
8236
|
+
Payments_GetStorePaymentSettings: {
|
|
8237
|
+
parameters: {
|
|
8238
|
+
query?: never;
|
|
8239
|
+
header?: never;
|
|
8240
|
+
path?: never;
|
|
8241
|
+
cookie?: never;
|
|
8242
|
+
};
|
|
8243
|
+
requestBody?: never;
|
|
8244
|
+
responses: {
|
|
8245
|
+
/** @description OK */
|
|
8246
|
+
200: {
|
|
8247
|
+
headers: {
|
|
8248
|
+
[name: string]: unknown;
|
|
8249
|
+
};
|
|
8250
|
+
content: {
|
|
8251
|
+
"application/json": components["schemas"]["StorePaymentSettingsDto"];
|
|
8252
|
+
};
|
|
8253
|
+
};
|
|
8254
|
+
/** @description Error response */
|
|
8255
|
+
default: {
|
|
8256
|
+
headers: {
|
|
8257
|
+
[name: string]: unknown;
|
|
8258
|
+
};
|
|
8259
|
+
content: {
|
|
8260
|
+
"application/json": components["schemas"]["PayNowError"];
|
|
8261
|
+
};
|
|
8262
|
+
};
|
|
8263
|
+
};
|
|
8264
|
+
};
|
|
8265
|
+
Payments_UpdateStorePaymentSettings: {
|
|
8266
|
+
parameters: {
|
|
8267
|
+
query?: never;
|
|
8268
|
+
header?: never;
|
|
8269
|
+
path?: never;
|
|
8270
|
+
cookie?: never;
|
|
8271
|
+
};
|
|
8272
|
+
requestBody?: {
|
|
8273
|
+
content: {
|
|
8274
|
+
"application/json": components["schemas"]["StorePaymentSettingsDto"];
|
|
8275
|
+
"text/json": components["schemas"]["StorePaymentSettingsDto"];
|
|
8276
|
+
"application/*+json": components["schemas"]["StorePaymentSettingsDto"];
|
|
8277
|
+
};
|
|
8278
|
+
};
|
|
8279
|
+
responses: {
|
|
8280
|
+
/** @description No Content */
|
|
8281
|
+
204: {
|
|
8282
|
+
headers: {
|
|
8283
|
+
[name: string]: unknown;
|
|
8284
|
+
};
|
|
8285
|
+
content?: never;
|
|
8286
|
+
};
|
|
8287
|
+
/** @description Error response */
|
|
8288
|
+
default: {
|
|
8289
|
+
headers: {
|
|
8290
|
+
[name: string]: unknown;
|
|
8291
|
+
};
|
|
8292
|
+
content: {
|
|
8293
|
+
"application/json": components["schemas"]["PayNowError"];
|
|
8294
|
+
};
|
|
8295
|
+
};
|
|
8296
|
+
};
|
|
8297
|
+
};
|
|
7482
8298
|
Products_GetProducts: {
|
|
7483
8299
|
parameters: {
|
|
7484
8300
|
query?: never;
|
|
@@ -9125,6 +9941,22 @@ export declare const operationMappings: {
|
|
|
9125
9941
|
readonly method: "POST";
|
|
9126
9942
|
readonly path: "/v1/stores/{storeId}/orders/{orderId}/refund";
|
|
9127
9943
|
};
|
|
9944
|
+
readonly Payments_GetPayments: {
|
|
9945
|
+
readonly method: "GET";
|
|
9946
|
+
readonly path: "/v1/stores/{storeId}/payments";
|
|
9947
|
+
};
|
|
9948
|
+
readonly Payments_GetPaymentById: {
|
|
9949
|
+
readonly method: "GET";
|
|
9950
|
+
readonly path: "/v1/stores/{storeId}/payments/{paymentId}";
|
|
9951
|
+
};
|
|
9952
|
+
readonly Payments_GetStorePaymentSettings: {
|
|
9953
|
+
readonly method: "GET";
|
|
9954
|
+
readonly path: "/v1/stores/{storeId}/payments/settings";
|
|
9955
|
+
};
|
|
9956
|
+
readonly Payments_UpdateStorePaymentSettings: {
|
|
9957
|
+
readonly method: "PATCH";
|
|
9958
|
+
readonly path: "/v1/stores/{storeId}/payments/settings";
|
|
9959
|
+
};
|
|
9128
9960
|
readonly Products_GetProducts: {
|
|
9129
9961
|
readonly method: "GET";
|
|
9130
9962
|
readonly path: "/v1/stores/{storeId}/products";
|