@leaflow/sdk 0.74.4 → 0.75.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/dist/billing/v1/schema.d.ts +34 -34
- package/package.json +1 -1
|
@@ -336,7 +336,7 @@ export interface paths {
|
|
|
336
336
|
put?: never;
|
|
337
337
|
/**
|
|
338
338
|
* Create top up
|
|
339
|
-
* @description Returns a checkout address. The balance increases when the payment
|
|
339
|
+
* @description Returns a checkout address. The balance increases when the payment gateway confirms the
|
|
340
340
|
* payment, which may be after this call returns.
|
|
341
341
|
*
|
|
342
342
|
* The amount is in the account's currency. A checkout page may present a local currency;
|
|
@@ -396,8 +396,8 @@ export interface paths {
|
|
|
396
396
|
put?: never;
|
|
397
397
|
/**
|
|
398
398
|
* Create payment method setup
|
|
399
|
-
* @description Returns what is needed to hand the browser over to the payment
|
|
400
|
-
* form. Nothing is charged, and the method appears in the list once the
|
|
399
|
+
* @description Returns what is needed to hand the browser over to the payment gateway's own card
|
|
400
|
+
* form. Nothing is charged, and the method appears in the list once the gateway
|
|
401
401
|
* confirms it.
|
|
402
402
|
*
|
|
403
403
|
* Card numbers are never sent to or stored by this service.
|
|
@@ -467,8 +467,8 @@ export interface paths {
|
|
|
467
467
|
* @description Applies the account balance first, then charges the remainder to a payment method. Give
|
|
468
468
|
* `payment_method_id` to choose one, or omit it to use the default.
|
|
469
469
|
*
|
|
470
|
-
* Returns a checkout address when the
|
|
471
|
-
* payment; the invoice is marked paid once the
|
|
470
|
+
* Returns a checkout address when the gateway requires the cardholder to confirm the
|
|
471
|
+
* payment; the invoice is marked paid once the gateway confirms it.
|
|
472
472
|
*
|
|
473
473
|
* Calling this on an invoice that is already paid returns the invoice unchanged.
|
|
474
474
|
*/
|
|
@@ -495,9 +495,9 @@ export interface paths {
|
|
|
495
495
|
*
|
|
496
496
|
* The balance is not split across the two cases: either it covers the whole total and
|
|
497
497
|
* everything is settled from it, or it is left untouched and the full total is collected
|
|
498
|
-
* through the
|
|
498
|
+
* through the gateway. It is never partly spent against an unpaid remainder.
|
|
499
499
|
*
|
|
500
|
-
* When the
|
|
500
|
+
* When the gateway is needed, this returns a checkout address and settles nothing.
|
|
501
501
|
* Call it again once the payment has landed — the balance then covers the total and the
|
|
502
502
|
* same call settles everything.
|
|
503
503
|
*
|
|
@@ -1955,15 +1955,15 @@ export interface components {
|
|
|
1955
1955
|
*/
|
|
1956
1956
|
remaining_amount?: components["schemas"]["Money"];
|
|
1957
1957
|
/**
|
|
1958
|
-
* @description `pending` until the payment
|
|
1958
|
+
* @description `pending` until the payment gateway confirms. The balance increases on `succeeded`.
|
|
1959
1959
|
*
|
|
1960
1960
|
* A checkout the payer abandoned ends up `failed` too, with `failure_reason` saying
|
|
1961
1961
|
* so. Nothing was charged in that case.
|
|
1962
1962
|
* @enum {string}
|
|
1963
1963
|
*/
|
|
1964
1964
|
status: "pending" | "requires_action" | "succeeded" | "failed";
|
|
1965
|
-
/** @description Which payment
|
|
1966
|
-
|
|
1965
|
+
/** @description Which payment gateway collected it. */
|
|
1966
|
+
payment_gateway?: string;
|
|
1967
1967
|
/**
|
|
1968
1968
|
* @description The currency the payer was actually charged in, when the checkout page collected a
|
|
1969
1969
|
* local one. Absent when it was the same as the account's.
|
|
@@ -1998,10 +1998,10 @@ export interface components {
|
|
|
1998
1998
|
/**
|
|
1999
1999
|
* @description In the account's currency, and no finer than that currency's smallest unit:
|
|
2000
2000
|
* two decimals for most, none for the yen. A finer amount is refused here rather
|
|
2001
|
-
* than at the checkout page, where the payer would see the
|
|
2001
|
+
* than at the checkout page, where the payer would see the gateway's own wording
|
|
2002
2002
|
* instead of an explanation.
|
|
2003
2003
|
*
|
|
2004
|
-
* There is a minimum, which differs by currency. Below it the
|
|
2004
|
+
* There is a minimum, which differs by currency. Below it the gateway's fee
|
|
2005
2005
|
* exceeds the top-up itself, so such a payment costs more to accept than it brings.
|
|
2006
2006
|
* The minimum in force is returned with the rejection.
|
|
2007
2007
|
*/
|
|
@@ -2029,7 +2029,7 @@ export interface components {
|
|
|
2029
2029
|
id: string;
|
|
2030
2030
|
/** Format: int64 */
|
|
2031
2031
|
billing_account_id: number;
|
|
2032
|
-
|
|
2032
|
+
payment_gateway?: string;
|
|
2033
2033
|
brand?: string;
|
|
2034
2034
|
last4?: string;
|
|
2035
2035
|
exp_month?: number | null;
|
|
@@ -2049,23 +2049,23 @@ export interface components {
|
|
|
2049
2049
|
return_url?: string;
|
|
2050
2050
|
};
|
|
2051
2051
|
/**
|
|
2052
|
-
* @description What the payment
|
|
2052
|
+
* @description What the payment gateway's browser library needs in order to collect a card. There is
|
|
2053
2053
|
* no address to redirect to: the form is rendered in the page, and the card goes straight
|
|
2054
|
-
* from the browser to the
|
|
2054
|
+
* from the browser to the gateway.
|
|
2055
2055
|
*/
|
|
2056
2056
|
PaymentMethodSetupResult: {
|
|
2057
2057
|
/**
|
|
2058
|
-
* @description The
|
|
2058
|
+
* @description The gateway's identifier for this attempt. Use it to tell a reloaded page apart
|
|
2059
2059
|
* from a second attempt.
|
|
2060
2060
|
*/
|
|
2061
2061
|
setup_id: string;
|
|
2062
2062
|
/**
|
|
2063
|
-
* @description Authorises this one attempt with the
|
|
2064
|
-
*
|
|
2063
|
+
* @description Authorises this one attempt with the gateway, and nothing else. Pass it to the
|
|
2064
|
+
* gateway's library; it is not an API credential and grants no access here.
|
|
2065
2065
|
*/
|
|
2066
2066
|
client_secret: string;
|
|
2067
2067
|
/**
|
|
2068
|
-
* @description The
|
|
2068
|
+
* @description The gateway's public key to initialise its library with. It differs between test
|
|
2069
2069
|
* and live, so read it from here rather than compiling it in.
|
|
2070
2070
|
*/
|
|
2071
2071
|
publishable_key: string;
|
|
@@ -2073,7 +2073,7 @@ export interface components {
|
|
|
2073
2073
|
expires_at?: string;
|
|
2074
2074
|
};
|
|
2075
2075
|
/**
|
|
2076
|
-
* @description Safe to call again. While an attempt is still with the payment
|
|
2076
|
+
* @description Safe to call again. While an attempt is still with the payment gateway, calling this
|
|
2077
2077
|
* returns that attempt rather than starting a second one, so a customer who reloads the
|
|
2078
2078
|
* page is not charged twice.
|
|
2079
2079
|
*
|
|
@@ -2102,7 +2102,7 @@ export interface components {
|
|
|
2102
2102
|
order_ids?: string[];
|
|
2103
2103
|
return_url?: string;
|
|
2104
2104
|
/**
|
|
2105
|
-
* @description Required when the
|
|
2105
|
+
* @description Required when the gateway is involved, because that is where the money moves. The
|
|
2106
2106
|
* same key returns the same checkout address instead of opening a second one.
|
|
2107
2107
|
*/
|
|
2108
2108
|
idempotency_key?: string;
|
|
@@ -2112,7 +2112,7 @@ export interface components {
|
|
|
2112
2112
|
*
|
|
2113
2113
|
* `succeeded` — collected in full. Nothing further is owed.
|
|
2114
2114
|
*
|
|
2115
|
-
* `processing` — submitted to the payment
|
|
2115
|
+
* `processing` — submitted to the payment gateway and awaiting its answer. **Do not
|
|
2116
2116
|
* submit it again**; poll the invoice or order, or wait to be notified. Some methods take
|
|
2117
2117
|
* minutes and a few take days.
|
|
2118
2118
|
*
|
|
@@ -2122,8 +2122,8 @@ export interface components {
|
|
|
2122
2122
|
* `failed` — this attempt did not go through. `failure_reason` says why, and paying again
|
|
2123
2123
|
* starts a fresh attempt.
|
|
2124
2124
|
*
|
|
2125
|
-
* The
|
|
2126
|
-
*
|
|
2125
|
+
* The gateway's own answer is what decides: an attempt is only `succeeded` once the
|
|
2126
|
+
* gateway says so, never because this call returned.
|
|
2127
2127
|
* @enum {string}
|
|
2128
2128
|
*/
|
|
2129
2129
|
PaymentStatus: "succeeded" | "processing" | "requires_action" | "failed";
|
|
@@ -2138,7 +2138,7 @@ export interface components {
|
|
|
2138
2138
|
amount_paid: components["schemas"]["Money"];
|
|
2139
2139
|
/**
|
|
2140
2140
|
* @description What is still outstanding. Zero once the payment succeeds. Unchanged while
|
|
2141
|
-
* `processing`: nothing is collected until the
|
|
2141
|
+
* `processing`: nothing is collected until the gateway confirms it.
|
|
2142
2142
|
*/
|
|
2143
2143
|
amount_due: components["schemas"]["Money"];
|
|
2144
2144
|
currency: string;
|
|
@@ -2162,7 +2162,7 @@ export interface components {
|
|
|
2162
2162
|
retriable?: boolean;
|
|
2163
2163
|
/**
|
|
2164
2164
|
* Format: date-time
|
|
2165
|
-
* @description The earliest sensible moment to try again. Present when the
|
|
2165
|
+
* @description The earliest sensible moment to try again. Present when the gateway asked for a
|
|
2166
2166
|
* wait.
|
|
2167
2167
|
*/
|
|
2168
2168
|
retry_after?: string | null;
|
|
@@ -2294,10 +2294,10 @@ export interface components {
|
|
|
2294
2294
|
/** Format: uuid */
|
|
2295
2295
|
order_id?: string | null;
|
|
2296
2296
|
/**
|
|
2297
|
-
* @description `pending` is a payment still with the
|
|
2297
|
+
* @description `pending` is a payment still with the gateway. Only one may be pending against any
|
|
2298
2298
|
* one invoice or order.
|
|
2299
2299
|
*
|
|
2300
|
-
* `failed` covers a payment the
|
|
2300
|
+
* `failed` covers a payment the gateway refused and one the payer walked away from
|
|
2301
2301
|
* alike; `failure_reason` says which. There is no separate cancelled state, because
|
|
2302
2302
|
* what to do next is the same either way — start a new one.
|
|
2303
2303
|
* @enum {string}
|
|
@@ -2417,10 +2417,10 @@ export interface components {
|
|
|
2417
2417
|
* @description Where the cash went.
|
|
2418
2418
|
* @enum {string}
|
|
2419
2419
|
*/
|
|
2420
|
-
destination?: "balance" | "
|
|
2420
|
+
destination?: "balance" | "gateway";
|
|
2421
2421
|
/**
|
|
2422
|
-
* @description `pending` — accepted, not yet sent to the payment
|
|
2423
|
-
*
|
|
2422
|
+
* @description `pending` — accepted, not yet sent to the payment gateway. `processing` — with the
|
|
2423
|
+
* gateway and awaiting its answer, which takes days for some methods. Neither is
|
|
2424
2424
|
* final, and neither means the money has moved.
|
|
2425
2425
|
* @enum {string}
|
|
2426
2426
|
*/
|
|
@@ -2457,12 +2457,12 @@ export interface components {
|
|
|
2457
2457
|
net_amount: components["schemas"]["Money"];
|
|
2458
2458
|
currency: string;
|
|
2459
2459
|
/**
|
|
2460
|
-
* @description Where the cash part would go. `
|
|
2460
|
+
* @description Where the cash part would go. `gateway` returns it to the method it was paid
|
|
2461
2461
|
* with; `balance` credits the account instead, which is the answer whenever the cash
|
|
2462
|
-
* came from more than one place or never went through a
|
|
2462
|
+
* came from more than one place or never went through a gateway at all.
|
|
2463
2463
|
* @enum {string}
|
|
2464
2464
|
*/
|
|
2465
|
-
destination: "balance" | "
|
|
2465
|
+
destination: "balance" | "gateway";
|
|
2466
2466
|
/**
|
|
2467
2467
|
* @description How `refundable_amount` splits by where the money came from. The amounts sum to it.
|
|
2468
2468
|
*
|