@leaflow/sdk 0.0.0-dev.210.g700abef → 0.0.0-dev.212.gea1bf06
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.
|
@@ -1542,9 +1542,11 @@ export interface components {
|
|
|
1542
1542
|
/**
|
|
1543
1543
|
* @description `pending` until the payment gateway reaches a result. The balance increases on `succeeded`.
|
|
1544
1544
|
*
|
|
1545
|
-
* `failed` means the gateway declined the payment.
|
|
1546
|
-
*
|
|
1547
|
-
* `
|
|
1545
|
+
* `failed` means the gateway declined the payment. A declined attempt ends the top-up at once
|
|
1546
|
+
* and the payment is withdrawn at the gateway; to pay another way, create a new top-up.
|
|
1547
|
+
* `canceled` means the attempt was withdrawn without collecting money; `cancellation_reason`
|
|
1548
|
+
* says why. Unknown gateway outcomes remain `pending`, and a browser redirect is not proof of
|
|
1549
|
+
* payment.
|
|
1548
1550
|
*
|
|
1549
1551
|
* `failed` and `canceled` are final. If the gateway nevertheless collects payment for such an
|
|
1550
1552
|
* attempt, the amount is credited as a separate `succeeded` top-up.
|
|
@@ -1567,7 +1569,13 @@ export interface components {
|
|
|
1567
1569
|
* the figure that appears on the customer's card or wallet statement.
|
|
1568
1570
|
*/
|
|
1569
1571
|
presentment_amount?: components["schemas"]["Money"];
|
|
1570
|
-
/**
|
|
1572
|
+
/**
|
|
1573
|
+
* @description Why the gateway declined it. Present with `failed`. The value is the gateway's own code,
|
|
1574
|
+
* passed on unchanged: the card issuer's decline code when there is one (Stripe's decline_code,
|
|
1575
|
+
* such as insufficient_funds or lost_card), otherwise the gateway's error code (Stripe's code,
|
|
1576
|
+
* such as card_declined, expired_card or payment_intent_authentication_failure). Clients map it
|
|
1577
|
+
* to their own wording and treat an unknown value as a generic decline.
|
|
1578
|
+
*/
|
|
1571
1579
|
failure_reason?: string;
|
|
1572
1580
|
/**
|
|
1573
1581
|
* @description The customer's next step while the top-up is `pending` and the gateway still awaits them. Returned
|
|
@@ -1746,7 +1754,9 @@ export interface components {
|
|
|
1746
1754
|
*
|
|
1747
1755
|
* succeeded means payment is complete. processing means confirmation is pending; poll the invoice or
|
|
1748
1756
|
* order rather than submitting another payment. requires_action means the customer must complete the
|
|
1749
|
-
* supplied action. failed means the attempt did not succeed and failure_reason explains the outcome
|
|
1757
|
+
* supplied action. failed means the attempt did not succeed and failure_reason explains the outcome; a
|
|
1758
|
+
* declined gateway payment is withdrawn at the gateway, and paying again starts a new payment with the
|
|
1759
|
+
* same or another method.
|
|
1750
1760
|
* @enum {string}
|
|
1751
1761
|
*/
|
|
1752
1762
|
PaymentStatus: "succeeded" | "processing" | "requires_action" | "failed";
|
|
@@ -1787,6 +1797,14 @@ export interface components {
|
|
|
1787
1797
|
invoice_id?: string | null;
|
|
1788
1798
|
/** Format: uuid */
|
|
1789
1799
|
order_id?: string | null;
|
|
1800
|
+
/**
|
|
1801
|
+
* @description Why the payment did not go through. Present with `failed`. For a declined gateway payment the
|
|
1802
|
+
* value is the gateway's own code, passed on unchanged: the card issuer's decline code when
|
|
1803
|
+
* there is one (Stripe's decline_code, such as insufficient_funds or lost_card), otherwise the
|
|
1804
|
+
* gateway's error code (Stripe's code, such as card_declined, expired_card or
|
|
1805
|
+
* payment_intent_authentication_failure). Clients map it to their own wording and treat an
|
|
1806
|
+
* unknown value as a generic decline.
|
|
1807
|
+
*/
|
|
1790
1808
|
failure_reason?: string;
|
|
1791
1809
|
};
|
|
1792
1810
|
/**
|
|
@@ -1921,9 +1939,9 @@ export interface components {
|
|
|
1921
1939
|
/** Format: uuid */
|
|
1922
1940
|
refund_id?: string;
|
|
1923
1941
|
/**
|
|
1924
|
-
* @description `failed` means the operation did not succeed; for a gateway payment, that the gateway declined
|
|
1925
|
-
* `canceled` means a gateway payment was withdrawn without collecting money
|
|
1926
|
-
* to pay remains open for another payment.
|
|
1942
|
+
* @description `failed` means the operation did not succeed; for a gateway payment, that the gateway declined
|
|
1943
|
+
* it. `canceled` means a gateway payment was withdrawn without collecting money. After either,
|
|
1944
|
+
* an invoice the payment was meant to pay remains open for another payment.
|
|
1927
1945
|
* @enum {string}
|
|
1928
1946
|
*/
|
|
1929
1947
|
status?: "pending" | "succeeded" | "failed" | "canceled";
|
|
@@ -1931,7 +1949,14 @@ export interface components {
|
|
|
1931
1949
|
cancellation_reason?: components["schemas"]["PaymentCancellationReason"];
|
|
1932
1950
|
payment_gateway?: string;
|
|
1933
1951
|
method_type?: string;
|
|
1934
|
-
/**
|
|
1952
|
+
/**
|
|
1953
|
+
* @description Why it failed. Present with `failed`. For a declined gateway payment the value is the
|
|
1954
|
+
* gateway's own code, passed on unchanged: the card issuer's decline code when there is one
|
|
1955
|
+
* (Stripe's decline_code, such as insufficient_funds or lost_card), otherwise the gateway's
|
|
1956
|
+
* error code (Stripe's code, such as card_declined, expired_card or
|
|
1957
|
+
* payment_intent_authentication_failure). Clients map it to their own wording and treat an
|
|
1958
|
+
* unknown value as a generic decline.
|
|
1959
|
+
*/
|
|
1935
1960
|
failure_reason?: string;
|
|
1936
1961
|
/** Format: date-time */
|
|
1937
1962
|
settled_at?: string;
|