@invonetwork/web-sdk 3.17.0 → 3.19.0
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/CHANGELOG.md +31 -0
- package/README.md +68 -41
- package/dist/{chunk-JGDNPNQX.js → chunk-YW2PYARQ.js} +60 -12
- package/dist/index.cjs +58 -10
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +2 -2
- package/dist/server.cjs +150 -32
- package/dist/server.d.cts +172 -31
- package/dist/server.d.ts +172 -31
- package/dist/server.js +94 -24
- package/dist/{types-CjJARoLk.d.cts → types-CCqgVhzf.d.cts} +235 -52
- package/dist/{types-CjJARoLk.d.ts → types-CCqgVhzf.d.ts} +235 -52
- package/package.json +1 -1
|
@@ -302,9 +302,29 @@ declare class InvoError extends Error {
|
|
|
302
302
|
* answering `"Order is not finalizable"` with no `not_authorized` status is
|
|
303
303
|
* equally terminal — the reconciler has already settled the order's fate. */
|
|
304
304
|
get isSteamAuthorizationDead(): boolean;
|
|
305
|
-
/**
|
|
306
|
-
*
|
|
305
|
+
/**
|
|
306
|
+
* True if a CARD purchase was below the card minimum (`BELOW_CARD_MINIMUM`, 400). Nothing
|
|
307
|
+
* was charged. Two floors answer with this code:
|
|
308
|
+
* - INVO's minimum card purchase, $2.99 by default, on coin purchases and Platform Commerce
|
|
309
|
+
* card sales (not subscriptions), enforced from 2026-10-27. Until that date a smaller
|
|
310
|
+
* purchase is accepted and the response carries `minPurchaseWarning` instead.
|
|
311
|
+
* {@link minUsd} and {@link enforcedFrom} carry the figures in force; the amount and the
|
|
312
|
+
* date are INVO settings, so read them from the error rather than hard-coding them.
|
|
313
|
+
* - the card rail's own floor of $0.50, at any date, on coin purchases (the direct route and
|
|
314
|
+
* hosted checkout session create, complete and create-intent) and Platform Commerce card
|
|
315
|
+
* purchases ({@link minUsd} reads `"0.50"` there, with no {@link enforcedFrom}).
|
|
316
|
+
* {@link minUsd} tells you which floor refused it.
|
|
317
|
+
*
|
|
318
|
+
* Card purchases only; purchases through a third-party storefront or payment rail are
|
|
319
|
+
* unaffected. Raise the amount; do not retry it unchanged.
|
|
320
|
+
*/
|
|
307
321
|
get isBelowCardMinimum(): boolean;
|
|
322
|
+
/** On `BELOW_CARD_MINIMUM`: the minimum card purchase in force (`min_usd`), USD decimal
|
|
323
|
+
* string, for example `"2.99"`. `undefined` when the body does not carry it. */
|
|
324
|
+
get minUsd(): string | undefined;
|
|
325
|
+
/** On `BELOW_CARD_MINIMUM`: the date INVO started enforcing the minimum card purchase
|
|
326
|
+
* (`enforced_from`), ISO 8601, for example `"2026-10-27"`. `undefined` when absent. */
|
|
327
|
+
get enforcedFrom(): string | undefined;
|
|
308
328
|
/** True if a CARD purchase exceeded INVO's maximum single card charge
|
|
309
329
|
* (`ABOVE_CARD_MAXIMUM`, 400) — split the sale or lower the amount. Do not retry it
|
|
310
330
|
* unchanged; nothing was charged.
|
|
@@ -316,22 +336,38 @@ declare class InvoError extends Error {
|
|
|
316
336
|
* `max_amount` of the hosted checkout's `validate-game` read. */
|
|
317
337
|
get isAboveCardMaximum(): boolean;
|
|
318
338
|
/**
|
|
319
|
-
* True when an UNACKNOWLEDGED `purchaseCurrency` was refused because the amount
|
|
320
|
-
* small to carry INVO's card fee (`AMOUNT_BELOW_FEE`, 400). Nothing was charged.
|
|
321
|
-
*
|
|
322
|
-
*
|
|
339
|
+
* True when an UNACKNOWLEDGED `purchaseCurrency` was refused because the amount was too
|
|
340
|
+
* small to carry INVO's card fee (`AMOUNT_BELOW_FEE`, 400). Nothing was charged.
|
|
341
|
+
*
|
|
342
|
+
* @deprecated No longer returned: under the 2026-09 pricing the partner pays the card fee,
|
|
343
|
+
* so it is never in the buyer's charge. Kept so existing code still compiles; a small card
|
|
344
|
+
* purchase now answers `BELOW_CARD_MINIMUM` ({@link isBelowCardMinimum}).
|
|
323
345
|
*/
|
|
324
346
|
get isAmountBelowFee(): boolean;
|
|
325
347
|
/**
|
|
326
|
-
* True when `purchaseCurrency` was sent an `acknowledgedTotalUsd`
|
|
327
|
-
*
|
|
328
|
-
*
|
|
348
|
+
* True when `purchaseCurrency` was sent an `acknowledgedTotalUsd` BELOW the total INVO would
|
|
349
|
+
* charge now (`QUOTE_STALE`, 409). Nothing was charged. Quote again, show the player the new
|
|
350
|
+
* total, and retry with it. {@link expectedTotalUsd} carries INVO's figure. A higher
|
|
351
|
+
* acknowledged total (for example an older fee-inclusive one) is not refused: INVO charges
|
|
352
|
+
* the true, lower total.
|
|
329
353
|
*/
|
|
330
354
|
get isQuoteStale(): boolean;
|
|
331
355
|
/** On `QUOTE_STALE`: the total INVO would charge (`expected_total_usd`), decimal string. */
|
|
332
356
|
get expectedTotalUsd(): string | undefined;
|
|
333
|
-
/** On `QUOTE_STALE`: the total you sent, as INVO read it
|
|
357
|
+
/** On `QUOTE_STALE` or `TAX_PLACE_UNAVAILABLE`: the total you sent, as INVO read it
|
|
358
|
+
* (`acknowledged_total_usd`). */
|
|
334
359
|
get acknowledgedTotalUsd(): string | undefined;
|
|
360
|
+
/**
|
|
361
|
+
* True when a Merchant of Record `purchaseCurrency` acknowledged a taxed total but INVO could
|
|
362
|
+
* not read the buyer's tax location from the card on this attempt, and the request carried no
|
|
363
|
+
* `country` to fall back on (`TAX_PLACE_UNAVAILABLE`, 409). Nothing was charged. Retry the
|
|
364
|
+
* purchase (a fresh attempt usually reads the card), or send the `country` (and
|
|
365
|
+
* `subdivision`) you quoted with. INVO never drops the tax a buyer was shown, so it refuses
|
|
366
|
+
* rather than charging a different figure. The body carries `retryable: true`.
|
|
367
|
+
*/
|
|
368
|
+
get isTaxPlaceUnavailable(): boolean;
|
|
369
|
+
/** On `TAX_PLACE_UNAVAILABLE`: the total without tax (`untaxed_total_usd`), decimal string. */
|
|
370
|
+
get untaxedTotalUsd(): string | undefined;
|
|
335
371
|
/**
|
|
336
372
|
* True if a Platform Commerce refund targeted an order that was already refunded
|
|
337
373
|
* (409). Idempotent outcome — the original refund did happen, so treat this as
|
|
@@ -862,6 +898,14 @@ interface CreateCheckoutResult {
|
|
|
862
898
|
* (`POST /api/platform-commerce/purchase`). Treat unknown codes as informational.
|
|
863
899
|
*/
|
|
864
900
|
warnings?: CheckoutWarning[];
|
|
901
|
+
/**
|
|
902
|
+
* Set when `usdAmount` is under INVO's minimum card purchase ($2.99 by default) and the
|
|
903
|
+
* session was still created because the minimum is not enforced yet (before 2026-10-27 by
|
|
904
|
+
* default). From the enforcement date the same request throws `400 BELOW_CARD_MINIMUM`
|
|
905
|
+
* (`err.isBelowCardMinimum`). Card sessions only. `undefined` when there is nothing to warn
|
|
906
|
+
* about.
|
|
907
|
+
*/
|
|
908
|
+
minPurchaseWarning?: MinPurchaseWarning;
|
|
865
909
|
raw: Record<string, unknown>;
|
|
866
910
|
}
|
|
867
911
|
/** A non-fatal note on a checkout session mint (see {@link CreateCheckoutResult.warnings}). */
|
|
@@ -877,29 +921,43 @@ interface PurchaseInput {
|
|
|
877
921
|
* USD, two decimals: the listed price of the coins.
|
|
878
922
|
*
|
|
879
923
|
* **Without `acknowledgedTotalUsd` this is exactly what the card is charged, never more**,
|
|
880
|
-
* and INVO's card fee (
|
|
881
|
-
*
|
|
882
|
-
*
|
|
883
|
-
*
|
|
924
|
+
* and the player receives the listed coins for it. INVO's card fee (4.5% + $0.30 on Open,
|
|
925
|
+
* 5.5% + $0.50 on Merchant of Record, plus 1.5% of the listed price (before tax) on a card issued outside the
|
|
926
|
+
* US) is charged to you, the partner, never to the player: $10.00 buys 100.00 coins at the
|
|
927
|
+
* default 10 per USD and your fee is $0.75 on Open. Card purchases only; purchases through a
|
|
928
|
+
* third-party storefront or payment rail are unaffected.
|
|
884
929
|
*
|
|
885
|
-
* Minimum: $
|
|
886
|
-
*
|
|
887
|
-
*
|
|
888
|
-
*
|
|
889
|
-
*
|
|
890
|
-
*
|
|
930
|
+
* Minimum card purchase: $2.99, enforced by INVO from 2026-10-27 (`400 BELOW_CARD_MINIMUM`,
|
|
931
|
+
* `err.isBelowCardMinimum`); until then a smaller amount is accepted and the response
|
|
932
|
+
* carries {@link PurchaseResult.minPurchaseWarning}. The amount and the date are INVO
|
|
933
|
+
* settings, so this package does not pin them. The card rail's own floor of $0.50 still
|
|
934
|
+
* applies. The maximum is an INVO runtime setting, $100,000.00 by default, editable by an
|
|
935
|
+
* admin and different per environment, so it is enforced on the request rather than
|
|
936
|
+
* pinned here: expect a 400 carrying the live figure.
|
|
891
937
|
*/
|
|
892
938
|
usdAmount: string | number;
|
|
893
939
|
/**
|
|
894
940
|
* The total you showed the player, taken from {@link CurrencyPurchaseQuote.totalUsd}
|
|
895
|
-
* (`InvoServer.quoteCurrencyPurchase`): the price plus
|
|
896
|
-
*
|
|
897
|
-
* are priced off `usdAmount`.
|
|
898
|
-
* charged
|
|
899
|
-
*
|
|
900
|
-
*
|
|
941
|
+
* (`InvoServer.quoteCurrencyPurchase`): the listed price plus any tax. No card fee is in
|
|
942
|
+
* it; the partner pays that. INVO never charges the card more than this figure, and the
|
|
943
|
+
* coins are priced off `usdAmount`. An older, higher fee-inclusive total is still
|
|
944
|
+
* accepted: the card is charged the true, lower total. Only a total BELOW what INVO would
|
|
945
|
+
* charge now is refused: nothing is charged and the call throws `409 QUOTE_STALE`
|
|
946
|
+
* (`err.isQuoteStale`, `err.expectedTotalUsd`); quote again and show the new total.
|
|
947
|
+
* Omitted, the card is charged exactly `usdAmount` and the player receives the listed
|
|
948
|
+
* coins.
|
|
901
949
|
*/
|
|
902
950
|
acknowledgedTotalUsd?: string | number;
|
|
951
|
+
/**
|
|
952
|
+
* The buyer's billing country you quoted with (ISO 3166-1 alpha-2, the `country` you sent to
|
|
953
|
+
* {@link InvoServer.quoteCurrencyPurchase}). Optional. Merchant of Record only: INVO uses it
|
|
954
|
+
* only when it cannot read the buyer's tax location from the card, so a buyer who was shown
|
|
955
|
+
* tax is charged it. Without it, such a purchase is refused with `409 TAX_PLACE_UNAVAILABLE`
|
|
956
|
+
* (`err.isTaxPlaceUnavailable`); nothing is charged, and a retry usually succeeds.
|
|
957
|
+
*/
|
|
958
|
+
country?: string;
|
|
959
|
+
/** A US state or Canadian province code you quoted with, with `country`. Optional. */
|
|
960
|
+
subdivision?: string;
|
|
903
961
|
/** Idempotency key. Required. */
|
|
904
962
|
purchaseReference: string;
|
|
905
963
|
rail?: Rail;
|
|
@@ -923,19 +981,45 @@ interface PurchaseResult {
|
|
|
923
981
|
orderId?: string;
|
|
924
982
|
newBalance?: string | number | null;
|
|
925
983
|
/**
|
|
926
|
-
*
|
|
927
|
-
* (
|
|
984
|
+
* The card fee the BUYER paid on this purchase, decimal string: `"0.00"` on INVO's card
|
|
985
|
+
* rail, where the partner pays the card fee ({@link partnerFeeUsd}). Present on a
|
|
986
|
+
* `success` response (backends from 2026-09-23 on); `undefined` otherwise. Kept for
|
|
987
|
+
* compatibility: a purchase settled under the earlier pricing may report a non-zero figure.
|
|
928
988
|
*/
|
|
929
989
|
processingFeeUsd?: string;
|
|
930
990
|
/**
|
|
931
|
-
*
|
|
932
|
-
*
|
|
933
|
-
* Present on a `success`
|
|
991
|
+
* Who paid INVO's card fee: `"partner"` on INVO's card rail (you did; the buyer paid the
|
|
992
|
+
* listed price and received the listed coins). `"charge"` and `"coins"` are the earlier
|
|
993
|
+
* pricing's values and may still appear on an older purchase. Present on a `success`
|
|
994
|
+
* response; `undefined` when the backend did not send it (this SDK never guesses it).
|
|
934
995
|
*/
|
|
935
996
|
feeTakenFrom?: FeeTakenFrom;
|
|
997
|
+
/**
|
|
998
|
+
* INVO's card fee charged to you, the partner, for this purchase, decimal string: 4.5% +
|
|
999
|
+
* $0.30 on Open, 5.5% + $0.50 on Merchant of Record ($0.75 on a $10.00 Open purchase). It
|
|
1000
|
+
* nets against your earnings and is not returned on a refund. Separate from
|
|
1001
|
+
* {@link internationalCardFeeUsd}. `undefined` when the fee does not apply to the purchase
|
|
1002
|
+
* (a third-party storefront or payment rail, an order charged before the 2026-09 pricing)
|
|
1003
|
+
* or the backend did not send it. `null` when the fee could not be booked when the purchase
|
|
1004
|
+
* completed: the purchase itself succeeded, and INVO books the fee shortly after.
|
|
1005
|
+
*/
|
|
1006
|
+
partnerFeeUsd?: string | null;
|
|
1007
|
+
/**
|
|
1008
|
+
* The international card fee charged to you, decimal string: 1.5% of the listed price
|
|
1009
|
+
* (before tax) when the card was issued outside the US, `"0.00"` otherwise, including when
|
|
1010
|
+
* the card's country cannot be determined (it then counts as domestic). `undefined` and
|
|
1011
|
+
* `null` on the same terms as {@link partnerFeeUsd}.
|
|
1012
|
+
*/
|
|
1013
|
+
internationalCardFeeUsd?: string | null;
|
|
1014
|
+
/**
|
|
1015
|
+
* Present while a card purchase under INVO's minimum card purchase is still accepted
|
|
1016
|
+
* (before the enforcement date); from that date the purchase is refused with
|
|
1017
|
+
* `400 BELOW_CARD_MINIMUM` instead. `undefined` when there is nothing to warn about.
|
|
1018
|
+
*/
|
|
1019
|
+
minPurchaseWarning?: MinPurchaseWarning;
|
|
936
1020
|
/** The coins credited to the player, decimal string. Present on a `success` response. */
|
|
937
1021
|
coinsCredited?: string;
|
|
938
|
-
/** What the card was charged, decimal string (
|
|
1022
|
+
/** What the card was charged, decimal string (the listed price plus any tax; no card fee). Present on a `success` response. */
|
|
939
1023
|
chargeTotalUsd?: string;
|
|
940
1024
|
/**
|
|
941
1025
|
* Merchant of Record accounts only: the number of the receipt INVO issued to the buyer for
|
|
@@ -952,10 +1036,36 @@ interface PurchaseResult {
|
|
|
952
1036
|
raw: Record<string, unknown>;
|
|
953
1037
|
}
|
|
954
1038
|
/**
|
|
955
|
-
*
|
|
956
|
-
*
|
|
1039
|
+
* Who paid INVO's card fee on a coin purchase. `"partner"`: you did (INVO's card rail from the
|
|
1040
|
+
* 2026-09 pricing on). `"charge"` (added on top of the price) and `"coins"` (taken out of the
|
|
1041
|
+
* coins) are the earlier pricing's values, kept so an older purchase still reads. Widened so a
|
|
1042
|
+
* value a later backend adds still compiles; treat an unknown value as informational.
|
|
1043
|
+
*/
|
|
1044
|
+
type FeeTakenFrom = "charge" | "coins" | "partner" | (string & {});
|
|
1045
|
+
/**
|
|
1046
|
+
* A card purchase below INVO's minimum card purchase ($2.99 by default), accepted with a
|
|
1047
|
+
* warning until the enforcement date (2026-10-27 by default). From that date the same
|
|
1048
|
+
* purchase is refused with `400 BELOW_CARD_MINIMUM` (`err.isBelowCardMinimum`). Applies to
|
|
1049
|
+
* INVO's card purchases only (coin purchases and Platform Commerce card sales, not
|
|
1050
|
+
* subscriptions); purchases through a third-party storefront or payment rail are unaffected.
|
|
1051
|
+
* The amount and date are INVO settings; read them from here, do not hard-code them.
|
|
957
1052
|
*/
|
|
958
|
-
|
|
1053
|
+
interface MinPurchaseWarning {
|
|
1054
|
+
/** Machine code, for example `"BELOW_CARD_MINIMUM"`. Treat an unknown value as informational. */
|
|
1055
|
+
code: string;
|
|
1056
|
+
/** The minimum card purchase, USD decimal string (for example `"2.99"`). */
|
|
1057
|
+
minUsd: string;
|
|
1058
|
+
/** The date enforcement starts, ISO 8601 (for example `"2026-10-27"`). */
|
|
1059
|
+
enforcedFrom: string;
|
|
1060
|
+
/** Additive: INVO's human-readable notice (`message`). `undefined` when absent. */
|
|
1061
|
+
message?: string;
|
|
1062
|
+
/**
|
|
1063
|
+
* Additive: `enforced` as sent. Platform Commerce card sales send it (`false`: a warning is
|
|
1064
|
+
* only ever the notice period); coin routes do not, so it is `undefined` there.
|
|
1065
|
+
*/
|
|
1066
|
+
enforced?: boolean;
|
|
1067
|
+
raw: Record<string, unknown>;
|
|
1068
|
+
}
|
|
959
1069
|
/** Input for `InvoServer.quoteCurrencyPurchase`. */
|
|
960
1070
|
interface CurrencyPurchaseQuoteInput {
|
|
961
1071
|
/** The player the purchase is for (the same field the purchase call sends). */
|
|
@@ -985,6 +1095,7 @@ interface CurrencyPurchaseQuoteBreakdown {
|
|
|
985
1095
|
taxNote: string;
|
|
986
1096
|
taxRatePct: string | null;
|
|
987
1097
|
taxJurisdiction: string | null;
|
|
1098
|
+
/** The card fee the buyer pays: `"0.00"` on INVO's card rail (the partner pays it). */
|
|
988
1099
|
processingFeeUsd: string;
|
|
989
1100
|
/** A sentence you can show as is, or `""` when there is no fee. */
|
|
990
1101
|
processingFeeNote: string;
|
|
@@ -993,41 +1104,72 @@ interface CurrencyPurchaseQuoteBreakdown {
|
|
|
993
1104
|
currencyName: string;
|
|
994
1105
|
raw: Record<string, unknown>;
|
|
995
1106
|
}
|
|
996
|
-
/**
|
|
1107
|
+
/**
|
|
1108
|
+
* What an UNACKNOWLEDGED purchase of the same amount would do. On INVO's card rail the buyer
|
|
1109
|
+
* pays no card fee either way, so this matches the acknowledged outcome apart from any tax.
|
|
1110
|
+
*/
|
|
997
1111
|
interface UnacknowledgedPurchaseOutcome {
|
|
998
1112
|
/** Exactly the `usdAmount` you quoted. */
|
|
999
1113
|
chargeTotalUsd: string;
|
|
1000
|
-
/** The fee
|
|
1114
|
+
/** The card fee the buyer pays: `"0.00"` on INVO's card rail. */
|
|
1001
1115
|
processingFeeUsd: string;
|
|
1002
1116
|
/** The coins the player would receive. */
|
|
1003
1117
|
coins: string;
|
|
1004
|
-
/**
|
|
1118
|
+
/**
|
|
1119
|
+
* Who pays INVO's card fee: `"partner"` on INVO's card rail under the 2026-09 pricing
|
|
1120
|
+
* (`"coins"` under the earlier pricing). INVO always sends it; should it ever be missing,
|
|
1121
|
+
* the SDK reads `"partner"` when the quote carries `partner_fee_usd`, otherwise `"coins"`.
|
|
1122
|
+
*/
|
|
1005
1123
|
feeTakenFrom: FeeTakenFrom;
|
|
1124
|
+
/** INVO's card fee you would be charged, decimal string, when the backend sends it. */
|
|
1125
|
+
partnerFeeUsd?: string | null;
|
|
1006
1126
|
}
|
|
1007
1127
|
/**
|
|
1008
1128
|
* Result of `InvoServer.quoteCurrencyPurchase`. It moves no money and creates nothing.
|
|
1009
1129
|
* Show the player `totalUsd`, then send that same figure back as `acknowledgedTotalUsd`.
|
|
1010
1130
|
*/
|
|
1011
1131
|
interface CurrencyPurchaseQuote {
|
|
1012
|
-
/**
|
|
1132
|
+
/**
|
|
1133
|
+
* The figure to display AND the figure to send back as `acknowledgedTotalUsd`: the listed
|
|
1134
|
+
* price plus any tax. No card fee is in it.
|
|
1135
|
+
*/
|
|
1013
1136
|
totalUsd: string;
|
|
1014
1137
|
/** `totalUsd` in cents. */
|
|
1015
1138
|
amountCents: number;
|
|
1016
1139
|
/** The listed price (your `usdAmount`). */
|
|
1017
1140
|
subtotalUsd: string;
|
|
1018
1141
|
/**
|
|
1019
|
-
*
|
|
1020
|
-
*
|
|
1142
|
+
* The card fee the buyer pays: `"0.00"` on INVO's card rail. INVO's card fee is charged to
|
|
1143
|
+
* you instead ({@link partnerFeeUsd}). Kept for compatibility.
|
|
1021
1144
|
*/
|
|
1022
1145
|
processingFeeUsd: string;
|
|
1023
|
-
/**
|
|
1146
|
+
/**
|
|
1147
|
+
* INVO's card fee you will be charged for this purchase, decimal string, when the backend
|
|
1148
|
+
* sends it: 4.5% + $0.30 on Open, 5.5% + $0.50 on Merchant of Record ($0.75 on $10.00 on
|
|
1149
|
+
* Open). The international card fee (1.5% of the listed price, before tax, on a card issued
|
|
1150
|
+
* outside the US) is separate and known only once the card is. Read the figure; do not
|
|
1151
|
+
* recompute it.
|
|
1152
|
+
*/
|
|
1153
|
+
partnerFeeUsd?: string | null;
|
|
1154
|
+
/**
|
|
1155
|
+
* `null` on a quote: no card is known yet, so the international card fee cannot be. The
|
|
1156
|
+
* purchase result and the `purchase.completed` webhook carry the booked figure.
|
|
1157
|
+
*/
|
|
1158
|
+
internationalCardFeeUsd?: string | null;
|
|
1159
|
+
/** See {@link PurchaseResult.minPurchaseWarning}. */
|
|
1160
|
+
minPurchaseWarning?: MinPurchaseWarning;
|
|
1161
|
+
/** Coins the player receives: the listed coins. */
|
|
1024
1162
|
coins: string;
|
|
1025
1163
|
currencyName: string;
|
|
1164
|
+
/**
|
|
1165
|
+
* Who pays INVO's card fee on this purchase: `"partner"` on INVO's card rail. `undefined`
|
|
1166
|
+
* when the backend did not send it.
|
|
1167
|
+
*/
|
|
1168
|
+
feeTakenFrom?: FeeTakenFrom;
|
|
1026
1169
|
breakdown: CurrencyPurchaseQuoteBreakdown;
|
|
1027
1170
|
/**
|
|
1028
1171
|
* What happens if you do NOT acknowledge: the card is charged exactly `usdAmount` and the
|
|
1029
|
-
*
|
|
1030
|
-
* would be refused with `AMOUNT_BELOW_FEE`).
|
|
1172
|
+
* player receives the listed coins. `null` when the backend sends none.
|
|
1031
1173
|
*/
|
|
1032
1174
|
ifUnacknowledged: UnacknowledgedPurchaseOutcome | null;
|
|
1033
1175
|
raw: Record<string, unknown>;
|
|
@@ -1302,6 +1444,12 @@ interface PlatformPurchaseResult {
|
|
|
1302
1444
|
/** True when this response REPLAYED an existing session for the same
|
|
1303
1445
|
* `clientRequestId` (safe retry — same URL, never a second charge). */
|
|
1304
1446
|
idempotentReplay?: boolean;
|
|
1447
|
+
/**
|
|
1448
|
+
* Additive (2026-09 pricing), card leg: set while a card total under INVO's minimum card
|
|
1449
|
+
* purchase ($2.99 by default) is still accepted, before the enforcement date. From that date
|
|
1450
|
+
* the purchase throws `400 BELOW_CARD_MINIMUM` (`err.isBelowCardMinimum`). Absent otherwise.
|
|
1451
|
+
*/
|
|
1452
|
+
minPurchaseWarning?: MinPurchaseWarning;
|
|
1305
1453
|
raw: Record<string, unknown>;
|
|
1306
1454
|
}
|
|
1307
1455
|
interface PlatformOrderStatusResult {
|
|
@@ -1363,7 +1511,7 @@ interface PlatformRefundResult {
|
|
|
1363
1511
|
newBalance?: string | number | null;
|
|
1364
1512
|
/** Card leg only: the card processor's refund id (for support/reconciliation). */
|
|
1365
1513
|
processorRefundId?: string;
|
|
1366
|
-
/** Always true
|
|
1514
|
+
/** Always true: INVO's fee is not returned on a refund. */
|
|
1367
1515
|
feeRetained?: boolean;
|
|
1368
1516
|
/**
|
|
1369
1517
|
* Card sale refunded in parts only (absent on a one-shot full refund): `true` while part
|
|
@@ -1379,6 +1527,18 @@ interface PlatformRefundResult {
|
|
|
1379
1527
|
chargeTotalUsd?: string;
|
|
1380
1528
|
/** Present only while something is left: the USD still refundable (send `refundRemaining: true`). */
|
|
1381
1529
|
remainingUsd?: string;
|
|
1530
|
+
/**
|
|
1531
|
+
* Card leg only (2026-09 pricing): the part of INVO's card fee on this refund that stays
|
|
1532
|
+
* charged to you, USD decimal string. The card fee is not returned on a refund. `undefined`
|
|
1533
|
+
* on the balance leg and from backends that do not send it.
|
|
1534
|
+
*/
|
|
1535
|
+
cardFeeChargedToPartnerUsd?: string;
|
|
1536
|
+
/**
|
|
1537
|
+
* Card leg only (2026-09 pricing): everything this refund takes from your earnings, USD
|
|
1538
|
+
* decimal string: your share of the sale reversed plus {@link cardFeeChargedToPartnerUsd}.
|
|
1539
|
+
* `undefined` on the balance leg and from backends that do not send it.
|
|
1540
|
+
*/
|
|
1541
|
+
partnerDebitedUsd?: string;
|
|
1382
1542
|
raw: Record<string, unknown>;
|
|
1383
1543
|
}
|
|
1384
1544
|
interface MountCheckoutOptions {
|
|
@@ -2497,7 +2657,7 @@ interface RefundResult {
|
|
|
2497
2657
|
/** `true` when the card refund had already been issued by an earlier attempt and this call recorded it. */
|
|
2498
2658
|
processorRefundAdopted: boolean;
|
|
2499
2659
|
invoFeeRetained: boolean;
|
|
2500
|
-
/** Your revenue reversed for the refunded portion (revenue only;
|
|
2660
|
+
/** Your revenue reversed for the refunded portion (revenue only; INVO's card fee charged to you is `cardFeeChargedToPartnerUsd`). */
|
|
2501
2661
|
partnerRevenueReversedUsd: string | null;
|
|
2502
2662
|
/** `full` | `prorata` | `none` (`none` on `pending_approval`). */
|
|
2503
2663
|
partnerRevenueReversalMode: string | null;
|
|
@@ -2515,16 +2675,37 @@ interface RefundResult {
|
|
|
2515
2675
|
/** The subscription's status after this call (`canceled` after a full refund). */
|
|
2516
2676
|
subscriptionStatus?: string | null;
|
|
2517
2677
|
/**
|
|
2518
|
-
*
|
|
2519
|
-
*
|
|
2678
|
+
* Kept for compatibility. Since 2026-09-28 (D-PRICE-012) a card refund charges no separate
|
|
2679
|
+
* payment processor fee: this reads `"0.00"` with `processingFeeBasis` `"none"`, and INVO's
|
|
2680
|
+
* card fee on the refunded part is `cardFeeChargedToPartnerUsd` instead. A receipt stored
|
|
2681
|
+
* before that release may still carry the processor fee here (`actual` or `estimated`).
|
|
2520
2682
|
*/
|
|
2521
2683
|
processingFeeUsd?: string | null;
|
|
2522
2684
|
processingFeeBasis?: RefundProcessingFeeBasis | (string & {}) | null;
|
|
2523
2685
|
/** Always `partner`. */
|
|
2524
2686
|
processingFeeBorneBy?: string | null;
|
|
2525
2687
|
processingFeeTransactionId?: string | null;
|
|
2526
|
-
/**
|
|
2688
|
+
/**
|
|
2689
|
+
* Everything this refund took from your revenue. Since 2026-09-28 the same value as
|
|
2690
|
+
* `partnerDebitedUsd` (`partnerRevenueReversedUsd` plus `cardFeeChargedToPartnerUsd`); on an
|
|
2691
|
+
* older stored receipt, `partnerRevenueReversedUsd` plus the processor fee then charged.
|
|
2692
|
+
*/
|
|
2527
2693
|
partnerTotalReversedUsd?: string | null;
|
|
2694
|
+
/**
|
|
2695
|
+
* Additive (2026-09-28, D-PRICE-012). INVO's card fee on the refunded part, charged to you:
|
|
2696
|
+
* a card refund costs you the whole refunded amount, as a Platform Commerce card refund does.
|
|
2697
|
+
* Across partial refunds of one charge it adds up to exactly INVO's fee on that charge.
|
|
2698
|
+
* `"0.00"` on a coin refund and on the 202 `pending_approval` body. `undefined` on a receipt
|
|
2699
|
+
* stored before that release (a replay of an older refund).
|
|
2700
|
+
*/
|
|
2701
|
+
cardFeeChargedToPartnerUsd?: string | null;
|
|
2702
|
+
/**
|
|
2703
|
+
* Additive (2026-09-28, D-PRICE-012). Your whole debit for this refund:
|
|
2704
|
+
* `partnerRevenueReversedUsd` plus `cardFeeChargedToPartnerUsd`, which equals the refunded
|
|
2705
|
+
* price before tax on a card refund. `"0.00"` on the 202 body. `undefined` on a receipt stored
|
|
2706
|
+
* before that release; read `partnerTotalReversedUsd` there.
|
|
2707
|
+
*/
|
|
2708
|
+
partnerDebitedUsd?: string | null;
|
|
2528
2709
|
initiation?: RefundInitiation | (string & {}) | null;
|
|
2529
2710
|
/** The refund request INVO approved, or `null` for your own self-serve refund. */
|
|
2530
2711
|
refundRequestId?: string | null;
|
|
@@ -2848,8 +3029,10 @@ interface PurchaseStatusResult {
|
|
|
2848
3029
|
message: string | null;
|
|
2849
3030
|
/**
|
|
2850
3031
|
* What the card is charged. Before payment it is what this checkout WILL charge.
|
|
2851
|
-
* `amountChargedUsd` minus `listedUsd` is the
|
|
2852
|
-
*
|
|
3032
|
+
* `amountChargedUsd` minus `listedUsd` is the tax, where INVO collects it (Merchant of
|
|
3033
|
+
* Record): the buyer pays no card fee on INVO's card rail, so a 200.00 pack charges 200.00
|
|
3034
|
+
* plus any tax. A purchase settled under the earlier pricing may also include the card fee
|
|
3035
|
+
* the buyer paid then.
|
|
2853
3036
|
*/
|
|
2854
3037
|
amountChargedUsd: string | null;
|
|
2855
3038
|
/** The listed pack price. */
|
|
@@ -2904,4 +3087,4 @@ interface CheckoutClientConfig {
|
|
|
2904
3087
|
hooks?: InvoHooks;
|
|
2905
3088
|
}
|
|
2906
3089
|
|
|
2907
|
-
export { type ListSubscriptionsOptions as $, type ApproveResult as A, type BalanceResult as B, type ConfirmReceiptResult as C, type DestinationsQuery as D, type EnrollmentBeginResult as E, type CardSetupInput as F, type CardSetupResult as G, Http as H, InvoError as I, type CardSetupConfirmInput as J, type CardSetupConfirmResult as K, type LinkDeviceResult as L, type MountCheckoutOptions as M, type PlayerCardsResult as N, type PlatformPurchaseInput as O, type PurchaseStatusResult as P, type PlatformPurchaseResult as Q, type RecoveryBeginResult as R, type PlatformOrderStatusResult as S, type PlatformRefundInput as T, type PlatformRefundResult as U, type VerificationMethod as V, type WaitForPurchaseInput as W, type CreateSubscriptionInput as X, type SubscriptionResult as Y, type GetSubscriptionOptions as Z, type GetSubscriptionResult as _, type PurchaseCredited as a, type ApproveWithDeviceCodeInput as a$, type SubscriptionListResult as a0, type CancelSubscriptionOptions as a1, type CancelResult as a2, type ChangeAmountResult as a3, type SetPaymentMethodInput as a4, type SetPaymentMethodResult as a5, type RefundSubscriptionInput as a6, type RefundResult as a7, type SteamSubscriptionInitInput as a8, type SteamInitResult as a9, type ItemHistoryQuery as aA, type ItemHistoryResult as aB, type ItemOrderQuery as aC, type PlayerBalanceQuery as aD, type PlayerBalanceResult as aE, type InboundPendingQuery as aF, type InboundPendingResult as aG, type LinkedIdentitiesQuery as aH, type LinkedIdentitiesResult as aI, type SmsVerifyResult as aJ, type ClaimTransferInput as aK, type ClaimResult as aL, type ClaimCurrencyInput as aM, type TransactionStatusResult as aN, type GuardianApprovalStatusResult as aO, type ServerDestinationsQuery as aP, type PhoneShareContact as aQ, type PhoneShareInitiateResult as aR, type PhoneShareApproveInput as aS, type PhoneShareApproveResult as aT, type PhoneShareStatusResult as aU, type BeginDeviceApprovalInput as aV, type DeviceApprovalGrant as aW, type PollDeviceApprovalInput as aX, type DeviceApprovalPollResult as aY, type ConfirmDeviceEnrollmentInput as aZ, type ConfirmDeviceEnrollmentResult as a_, type SteamFinalizeSubscriptionResult as aa, type SandboxClockResult as ab, type SandboxFailureOutcome as ac, type SandboxForceFailureOptions as ad, type SandboxForceAuthChallengeOptions as ae, type ServerConfig as af, type PlayerToken as ag, type InitiateSendInput as ah, type InitiateResult as ai, type InitiateTransferInput as aj, type CreateCheckoutInput as ak, type CreateCheckoutResult as al, type PurchaseInput as am, type PurchaseResult as an, type CurrencyPurchaseQuoteInput as ao, type CurrencyPurchaseQuote as ap, type ConfirmPaymentResult as aq, type OrderDetailsResult as ar, type SteamPacksQuery as as, type SteamPacksResult as at, type SteamInitPurchaseInput as au, type SteamInitPurchaseResult as av, type SteamFinalizeInput as aw, type SteamFinalizeResult as ax, type PurchaseItemInput as ay, type PurchaseItemResult as az, type PurchaseExpired as b, type DeviceApprovalSettleResult as b0, type CompleteDeviceApprovalInput as b1, type CompleteDeviceApprovalResult as b2, type CardSetupStatus as b3, type CheckoutWarning as b4, type CurrencyBalance as b5, type CurrencyPurchaseQuoteBreakdown as b6, type DeviceApprovalChannel as b7, type DeviceApprovalEnrollment as b8, type DeviceApprovalFlow as b9, type
|
|
3090
|
+
export { type ListSubscriptionsOptions as $, type ApproveResult as A, type BalanceResult as B, type ConfirmReceiptResult as C, type DestinationsQuery as D, type EnrollmentBeginResult as E, type CardSetupInput as F, type CardSetupResult as G, Http as H, InvoError as I, type CardSetupConfirmInput as J, type CardSetupConfirmResult as K, type LinkDeviceResult as L, type MountCheckoutOptions as M, type PlayerCardsResult as N, type PlatformPurchaseInput as O, type PurchaseStatusResult as P, type PlatformPurchaseResult as Q, type RecoveryBeginResult as R, type PlatformOrderStatusResult as S, type PlatformRefundInput as T, type PlatformRefundResult as U, type VerificationMethod as V, type WaitForPurchaseInput as W, type CreateSubscriptionInput as X, type SubscriptionResult as Y, type GetSubscriptionOptions as Z, type GetSubscriptionResult as _, type PurchaseCredited as a, type ApproveWithDeviceCodeInput as a$, type SubscriptionListResult as a0, type CancelSubscriptionOptions as a1, type CancelResult as a2, type ChangeAmountResult as a3, type SetPaymentMethodInput as a4, type SetPaymentMethodResult as a5, type RefundSubscriptionInput as a6, type RefundResult as a7, type SteamSubscriptionInitInput as a8, type SteamInitResult as a9, type ItemHistoryQuery as aA, type ItemHistoryResult as aB, type ItemOrderQuery as aC, type PlayerBalanceQuery as aD, type PlayerBalanceResult as aE, type InboundPendingQuery as aF, type InboundPendingResult as aG, type LinkedIdentitiesQuery as aH, type LinkedIdentitiesResult as aI, type SmsVerifyResult as aJ, type ClaimTransferInput as aK, type ClaimResult as aL, type ClaimCurrencyInput as aM, type TransactionStatusResult as aN, type GuardianApprovalStatusResult as aO, type ServerDestinationsQuery as aP, type PhoneShareContact as aQ, type PhoneShareInitiateResult as aR, type PhoneShareApproveInput as aS, type PhoneShareApproveResult as aT, type PhoneShareStatusResult as aU, type BeginDeviceApprovalInput as aV, type DeviceApprovalGrant as aW, type PollDeviceApprovalInput as aX, type DeviceApprovalPollResult as aY, type ConfirmDeviceEnrollmentInput as aZ, type ConfirmDeviceEnrollmentResult as a_, type SteamFinalizeSubscriptionResult as aa, type SandboxClockResult as ab, type SandboxFailureOutcome as ac, type SandboxForceFailureOptions as ad, type SandboxForceAuthChallengeOptions as ae, type ServerConfig as af, type PlayerToken as ag, type InitiateSendInput as ah, type InitiateResult as ai, type InitiateTransferInput as aj, type CreateCheckoutInput as ak, type CreateCheckoutResult as al, type PurchaseInput as am, type PurchaseResult as an, type CurrencyPurchaseQuoteInput as ao, type CurrencyPurchaseQuote as ap, type ConfirmPaymentResult as aq, type OrderDetailsResult as ar, type SteamPacksQuery as as, type SteamPacksResult as at, type SteamInitPurchaseInput as au, type SteamInitPurchaseResult as av, type SteamFinalizeInput as aw, type SteamFinalizeResult as ax, type PurchaseItemInput as ay, type PurchaseItemResult as az, type PurchaseExpired as b, type DeviceApprovalSettleResult as b0, type CompleteDeviceApprovalInput as b1, type CompleteDeviceApprovalResult as b2, type CardSetupStatus as b3, type CheckoutWarning as b4, type CurrencyBalance as b5, type CurrencyPurchaseQuoteBreakdown as b6, type DeviceApprovalChannel as b7, type DeviceApprovalEnrollment as b8, type DeviceApprovalFlow as b9, type SubscriptionInterval as bA, type SubscriptionRevenueShare as bB, type SubscriptionRevenueShareInput as bC, type SubscriptionStatus as bD, type UnacknowledgedPurchaseOutcome as bE, isRefundPendingApproval as bF, type DeviceApprovalPollStatus as ba, type DeviceEnrollmentDecision as bb, type DeviceEnrollmentRespond as bc, type FeeTakenFrom as bd, type FirstCharge as be, type FirstChargeStatus as bf, type FundingSource as bg, type InboundPendingItem as bh, type LinkedIdentityEmail as bi, type MinPurchaseWarning as bj, type PlatformPurchaseStatus as bk, type RefundInitiation as bl, type RefundPendingApproval as bm, type RefundProcessingFeeBasis as bn, type RefundReceipt as bo, type RefundRevenueShareAttribution as bp, type RefundWarning as bq, type SandboxClockState as br, type SavedCard as bs, type SteamPack as bt, type SteamUserSession as bu, type Subscription as bv, type SubscriptionBaseInput as bw, type SubscriptionConsent as bx, type SubscriptionConsentInput as by, type SubscriptionFundingRail as bz, type PurchaseRefunded as c, type PurchaseRefused as d, type CheckoutClientConfig as e, type PurchaseStatusInput as f, type CallOptions as g, type CheckoutMountHandle as h, type ClientConfig as i, type PendingCollectResult as j, type DestinationsResult as k, type EnrollmentVerifyResult as l, type RecoveryCompleteResult as m, type BalanceRow as n, type CheckoutPurchaseStatus as o, type DestinationGame as p, type InvoErrorInfo as q, type InvoHooks as r, type InvoRequestInfo as s, type InvoResponseInfo as t, type PendingCollectItem as u, type PurchaseRefusalReason as v, type Rail as w, type AuthHeader as x, type CardSetupSessionInput as y, type CardSetupSessionResult as z };
|