@naturalpay/sdk 1.6.10 → 1.6.11
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/cjs/BaseClient.js +2 -2
- package/dist/cjs/Client.d.ts +8 -8
- package/dist/cjs/Client.js +16 -16
- package/dist/cjs/api/resources/externalParties/client/requests/NewExtPartyParams.d.ts +1 -1
- package/dist/cjs/api/resources/externalParties/types/NewExtPartyParamsAddress.d.ts +7 -4
- package/dist/cjs/api/resources/transactions/types/ListTransactionsRequestType.d.ts +1 -0
- package/dist/cjs/api/resources/transactions/types/ListTransactionsRequestType.js +1 -0
- package/dist/cjs/api/resources/transactions/types/TxnDetailTransactionType.d.ts +1 -0
- package/dist/cjs/api/resources/transactions/types/TxnDetailTransactionType.js +1 -0
- package/dist/cjs/api/resources/transactions/types/TxnTransactionType.d.ts +1 -0
- package/dist/cjs/api/resources/transactions/types/TxnTransactionType.js +1 -0
- package/dist/cjs/serialization/resources/externalParties/types/NewExtPartyParamsAddress.d.ts +3 -3
- package/dist/cjs/serialization/resources/externalParties/types/NewExtPartyParamsAddress.js +3 -3
- package/dist/cjs/serialization/resources/transactions/types/ListTransactionsRequestType.d.ts +1 -1
- package/dist/cjs/serialization/resources/transactions/types/ListTransactionsRequestType.js +1 -1
- package/dist/cjs/serialization/resources/transactions/types/TxnDetailTransactionType.d.ts +1 -1
- package/dist/cjs/serialization/resources/transactions/types/TxnDetailTransactionType.js +1 -1
- package/dist/cjs/serialization/resources/transactions/types/TxnTransactionType.d.ts +1 -1
- package/dist/cjs/serialization/resources/transactions/types/TxnTransactionType.js +1 -1
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/Client.d.mts +8 -8
- package/dist/esm/Client.mjs +16 -16
- package/dist/esm/api/resources/externalParties/client/requests/NewExtPartyParams.d.mts +1 -1
- package/dist/esm/api/resources/externalParties/types/NewExtPartyParamsAddress.d.mts +7 -4
- package/dist/esm/api/resources/transactions/types/ListTransactionsRequestType.d.mts +1 -0
- package/dist/esm/api/resources/transactions/types/ListTransactionsRequestType.mjs +1 -0
- package/dist/esm/api/resources/transactions/types/TxnDetailTransactionType.d.mts +1 -0
- package/dist/esm/api/resources/transactions/types/TxnDetailTransactionType.mjs +1 -0
- package/dist/esm/api/resources/transactions/types/TxnTransactionType.d.mts +1 -0
- package/dist/esm/api/resources/transactions/types/TxnTransactionType.mjs +1 -0
- package/dist/esm/serialization/resources/externalParties/types/NewExtPartyParamsAddress.d.mts +3 -3
- package/dist/esm/serialization/resources/externalParties/types/NewExtPartyParamsAddress.mjs +3 -3
- package/dist/esm/serialization/resources/transactions/types/ListTransactionsRequestType.d.mts +1 -1
- package/dist/esm/serialization/resources/transactions/types/ListTransactionsRequestType.mjs +1 -1
- package/dist/esm/serialization/resources/transactions/types/TxnDetailTransactionType.d.mts +1 -1
- package/dist/esm/serialization/resources/transactions/types/TxnDetailTransactionType.mjs +1 -1
- package/dist/esm/serialization/resources/transactions/types/TxnTransactionType.d.mts +1 -1
- package/dist/esm/serialization/resources/transactions/types/TxnTransactionType.mjs +1 -1
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +45 -45
- package/reference.md +573 -573
package/reference.md
CHANGED
|
@@ -1716,8 +1716,8 @@ await client.payments.cancel({
|
|
|
1716
1716
|
</dl>
|
|
1717
1717
|
</details>
|
|
1718
1718
|
|
|
1719
|
-
##
|
|
1720
|
-
<details><summary><code>client.
|
|
1719
|
+
## External Parties
|
|
1720
|
+
<details><summary><code>client.externalParties.<a href="/src/api/resources/externalParties/client/Client.ts">list</a>({ ...params }) -> core.Page<Natural.ListExternalPartiesResponseDataItem, Natural.ExtParty></code></summary>
|
|
1721
1721
|
<dl>
|
|
1722
1722
|
<dd>
|
|
1723
1723
|
|
|
@@ -1729,7 +1729,7 @@ await client.payments.cancel({
|
|
|
1729
1729
|
<dl>
|
|
1730
1730
|
<dd>
|
|
1731
1731
|
|
|
1732
|
-
List
|
|
1732
|
+
List your external parties
|
|
1733
1733
|
</dd>
|
|
1734
1734
|
</dl>
|
|
1735
1735
|
</dd>
|
|
@@ -1744,13 +1744,13 @@ List transactions
|
|
|
1744
1744
|
<dd>
|
|
1745
1745
|
|
|
1746
1746
|
```typescript
|
|
1747
|
-
const pageableResponse = await client.
|
|
1747
|
+
const pageableResponse = await client.externalParties.list();
|
|
1748
1748
|
for await (const item of pageableResponse) {
|
|
1749
1749
|
console.log(item);
|
|
1750
1750
|
}
|
|
1751
1751
|
|
|
1752
1752
|
// Or you can manually iterate page-by-page
|
|
1753
|
-
let page = await client.
|
|
1753
|
+
let page = await client.externalParties.list();
|
|
1754
1754
|
while (page.hasNextPage()) {
|
|
1755
1755
|
page = page.getNextPage();
|
|
1756
1756
|
}
|
|
@@ -1772,7 +1772,7 @@ const response = page.response;
|
|
|
1772
1772
|
<dl>
|
|
1773
1773
|
<dd>
|
|
1774
1774
|
|
|
1775
|
-
**request:** `Natural.
|
|
1775
|
+
**request:** `Natural.ListExternalPartiesRequest`
|
|
1776
1776
|
|
|
1777
1777
|
</dd>
|
|
1778
1778
|
</dl>
|
|
@@ -1780,7 +1780,7 @@ const response = page.response;
|
|
|
1780
1780
|
<dl>
|
|
1781
1781
|
<dd>
|
|
1782
1782
|
|
|
1783
|
-
**requestOptions:** `
|
|
1783
|
+
**requestOptions:** `ExternalPartiesClient.RequestOptions`
|
|
1784
1784
|
|
|
1785
1785
|
</dd>
|
|
1786
1786
|
</dl>
|
|
@@ -1792,7 +1792,7 @@ const response = page.response;
|
|
|
1792
1792
|
</dl>
|
|
1793
1793
|
</details>
|
|
1794
1794
|
|
|
1795
|
-
<details><summary><code>client.
|
|
1795
|
+
<details><summary><code>client.externalParties.<a href="/src/api/resources/externalParties/client/Client.ts">create</a>({ ...params }) -> Natural.NewExtParty</code></summary>
|
|
1796
1796
|
<dl>
|
|
1797
1797
|
<dd>
|
|
1798
1798
|
|
|
@@ -1804,7 +1804,7 @@ const response = page.response;
|
|
|
1804
1804
|
<dl>
|
|
1805
1805
|
<dd>
|
|
1806
1806
|
|
|
1807
|
-
|
|
1807
|
+
Create an external party to transact with over Direct
|
|
1808
1808
|
</dd>
|
|
1809
1809
|
</dl>
|
|
1810
1810
|
</dd>
|
|
@@ -1819,8 +1819,19 @@ Get a transaction
|
|
|
1819
1819
|
<dd>
|
|
1820
1820
|
|
|
1821
1821
|
```typescript
|
|
1822
|
-
await client.
|
|
1823
|
-
|
|
1822
|
+
await client.externalParties.create({
|
|
1823
|
+
idempotencyKey: "Idempotency-Key",
|
|
1824
|
+
kind: "individual",
|
|
1825
|
+
name: "Jordan Rivera",
|
|
1826
|
+
email: "jordan@example.com",
|
|
1827
|
+
phone: "+1 415 555 0132",
|
|
1828
|
+
address: {
|
|
1829
|
+
line1: "123 Market St",
|
|
1830
|
+
city: "San Francisco",
|
|
1831
|
+
state: "CA",
|
|
1832
|
+
postalCode: "94105",
|
|
1833
|
+
countryCode: "US"
|
|
1834
|
+
}
|
|
1824
1835
|
});
|
|
1825
1836
|
|
|
1826
1837
|
```
|
|
@@ -1837,7 +1848,7 @@ await client.transactions.get({
|
|
|
1837
1848
|
<dl>
|
|
1838
1849
|
<dd>
|
|
1839
1850
|
|
|
1840
|
-
**request:** `Natural.
|
|
1851
|
+
**request:** `Natural.NewExtPartyParams`
|
|
1841
1852
|
|
|
1842
1853
|
</dd>
|
|
1843
1854
|
</dl>
|
|
@@ -1845,7 +1856,7 @@ await client.transactions.get({
|
|
|
1845
1856
|
<dl>
|
|
1846
1857
|
<dd>
|
|
1847
1858
|
|
|
1848
|
-
**requestOptions:** `
|
|
1859
|
+
**requestOptions:** `ExternalPartiesClient.RequestOptions`
|
|
1849
1860
|
|
|
1850
1861
|
</dd>
|
|
1851
1862
|
</dl>
|
|
@@ -1857,8 +1868,7 @@ await client.transactions.get({
|
|
|
1857
1868
|
</dl>
|
|
1858
1869
|
</details>
|
|
1859
1870
|
|
|
1860
|
-
|
|
1861
|
-
<details><summary><code>client.transfers.<a href="/src/api/resources/transfers/client/Client.ts">initiateDeposit</a>({ ...params }) -> Natural.Deposit</code></summary>
|
|
1871
|
+
<details><summary><code>client.externalParties.<a href="/src/api/resources/externalParties/client/Client.ts">get</a>({ ...params }) -> Natural.ExtPartyDetail</code></summary>
|
|
1862
1872
|
<dl>
|
|
1863
1873
|
<dd>
|
|
1864
1874
|
|
|
@@ -1870,7 +1880,7 @@ await client.transactions.get({
|
|
|
1870
1880
|
<dl>
|
|
1871
1881
|
<dd>
|
|
1872
1882
|
|
|
1873
|
-
|
|
1883
|
+
Get an external party by ID
|
|
1874
1884
|
</dd>
|
|
1875
1885
|
</dl>
|
|
1876
1886
|
</dd>
|
|
@@ -1885,15 +1895,8 @@ Move funds from a linked bank account into a wallet
|
|
|
1885
1895
|
<dd>
|
|
1886
1896
|
|
|
1887
1897
|
```typescript
|
|
1888
|
-
await client.
|
|
1889
|
-
|
|
1890
|
-
amount: 50000,
|
|
1891
|
-
currency: "USD",
|
|
1892
|
-
externalAccountId: "eac_550e8400e29b41d4a716446655440000",
|
|
1893
|
-
description: "Wallet top-up",
|
|
1894
|
-
tags: {
|
|
1895
|
-
"workflow": "treasury"
|
|
1896
|
-
}
|
|
1898
|
+
await client.externalParties.get({
|
|
1899
|
+
externalPartyId: "externalPartyId"
|
|
1897
1900
|
});
|
|
1898
1901
|
|
|
1899
1902
|
```
|
|
@@ -1910,7 +1913,7 @@ await client.transfers.initiateDeposit({
|
|
|
1910
1913
|
<dl>
|
|
1911
1914
|
<dd>
|
|
1912
1915
|
|
|
1913
|
-
**request:** `Natural.
|
|
1916
|
+
**request:** `Natural.GetExternalPartiesRequest`
|
|
1914
1917
|
|
|
1915
1918
|
</dd>
|
|
1916
1919
|
</dl>
|
|
@@ -1918,7 +1921,7 @@ await client.transfers.initiateDeposit({
|
|
|
1918
1921
|
<dl>
|
|
1919
1922
|
<dd>
|
|
1920
1923
|
|
|
1921
|
-
**requestOptions:** `
|
|
1924
|
+
**requestOptions:** `ExternalPartiesClient.RequestOptions`
|
|
1922
1925
|
|
|
1923
1926
|
</dd>
|
|
1924
1927
|
</dl>
|
|
@@ -1930,7 +1933,8 @@ await client.transfers.initiateDeposit({
|
|
|
1930
1933
|
</dl>
|
|
1931
1934
|
</details>
|
|
1932
1935
|
|
|
1933
|
-
|
|
1936
|
+
## External Party Accounts
|
|
1937
|
+
<details><summary><code>client.externalPartyAccounts.<a href="/src/api/resources/externalPartyAccounts/client/Client.ts">list</a>({ ...params }) -> core.Page<Natural.ListExternalPartyAccountsResponseDataItem, Natural.ExtPartyAcct></code></summary>
|
|
1934
1938
|
<dl>
|
|
1935
1939
|
<dd>
|
|
1936
1940
|
|
|
@@ -1942,7 +1946,7 @@ await client.transfers.initiateDeposit({
|
|
|
1942
1946
|
<dl>
|
|
1943
1947
|
<dd>
|
|
1944
1948
|
|
|
1945
|
-
|
|
1949
|
+
List the accounts that belong to an external party
|
|
1946
1950
|
</dd>
|
|
1947
1951
|
</dl>
|
|
1948
1952
|
</dd>
|
|
@@ -1957,17 +1961,23 @@ Move funds from a wallet to a linked bank account
|
|
|
1957
1961
|
<dd>
|
|
1958
1962
|
|
|
1959
1963
|
```typescript
|
|
1960
|
-
await client.
|
|
1961
|
-
|
|
1962
|
-
amount: 12500,
|
|
1963
|
-
currency: "USD",
|
|
1964
|
-
externalAccountId: "eac_550e8400e29b41d4a716446655440000",
|
|
1965
|
-
method: "standard",
|
|
1966
|
-
description: "Payout transfer",
|
|
1967
|
-
tags: {
|
|
1968
|
-
"workflow": "treasury"
|
|
1969
|
-
}
|
|
1964
|
+
const pageableResponse = await client.externalPartyAccounts.list({
|
|
1965
|
+
externalPartyId: "externalPartyId"
|
|
1970
1966
|
});
|
|
1967
|
+
for await (const item of pageableResponse) {
|
|
1968
|
+
console.log(item);
|
|
1969
|
+
}
|
|
1970
|
+
|
|
1971
|
+
// Or you can manually iterate page-by-page
|
|
1972
|
+
let page = await client.externalPartyAccounts.list({
|
|
1973
|
+
externalPartyId: "externalPartyId"
|
|
1974
|
+
});
|
|
1975
|
+
while (page.hasNextPage()) {
|
|
1976
|
+
page = page.getNextPage();
|
|
1977
|
+
}
|
|
1978
|
+
|
|
1979
|
+
// You can also access the underlying response
|
|
1980
|
+
const response = page.response;
|
|
1971
1981
|
|
|
1972
1982
|
```
|
|
1973
1983
|
</dd>
|
|
@@ -1983,7 +1993,7 @@ await client.transfers.initiateWithdrawal({
|
|
|
1983
1993
|
<dl>
|
|
1984
1994
|
<dd>
|
|
1985
1995
|
|
|
1986
|
-
**request:** `Natural.
|
|
1996
|
+
**request:** `Natural.ListExternalPartyAccountsRequest`
|
|
1987
1997
|
|
|
1988
1998
|
</dd>
|
|
1989
1999
|
</dl>
|
|
@@ -1991,7 +2001,7 @@ await client.transfers.initiateWithdrawal({
|
|
|
1991
2001
|
<dl>
|
|
1992
2002
|
<dd>
|
|
1993
2003
|
|
|
1994
|
-
**requestOptions:** `
|
|
2004
|
+
**requestOptions:** `ExternalPartyAccountsClient.RequestOptions`
|
|
1995
2005
|
|
|
1996
2006
|
</dd>
|
|
1997
2007
|
</dl>
|
|
@@ -2003,7 +2013,7 @@ await client.transfers.initiateWithdrawal({
|
|
|
2003
2013
|
</dl>
|
|
2004
2014
|
</details>
|
|
2005
2015
|
|
|
2006
|
-
<details><summary><code>client.
|
|
2016
|
+
<details><summary><code>client.externalPartyAccounts.<a href="/src/api/resources/externalPartyAccounts/client/Client.ts">create</a>({ ...params }) -> Natural.NewExtPartyAcct</code></summary>
|
|
2007
2017
|
<dl>
|
|
2008
2018
|
<dd>
|
|
2009
2019
|
|
|
@@ -2015,7 +2025,7 @@ await client.transfers.initiateWithdrawal({
|
|
|
2015
2025
|
<dl>
|
|
2016
2026
|
<dd>
|
|
2017
2027
|
|
|
2018
|
-
|
|
2028
|
+
Store banking details for an external party
|
|
2019
2029
|
</dd>
|
|
2020
2030
|
</dl>
|
|
2021
2031
|
</dd>
|
|
@@ -2030,15 +2040,16 @@ Move funds between two wallets
|
|
|
2030
2040
|
<dd>
|
|
2031
2041
|
|
|
2032
2042
|
```typescript
|
|
2033
|
-
await client.
|
|
2043
|
+
await client.externalPartyAccounts.create({
|
|
2034
2044
|
idempotencyKey: "Idempotency-Key",
|
|
2035
|
-
|
|
2036
|
-
|
|
2037
|
-
|
|
2038
|
-
|
|
2039
|
-
|
|
2040
|
-
|
|
2041
|
-
}
|
|
2045
|
+
externalPartyId: "epty_550e8400e29b41d4a716446655440000",
|
|
2046
|
+
accountDetails: {
|
|
2047
|
+
type: "us_bank_account",
|
|
2048
|
+
accountType: "checking",
|
|
2049
|
+
accountNumber: "123456786789",
|
|
2050
|
+
routingNumber: "121000358"
|
|
2051
|
+
},
|
|
2052
|
+
institutionName: "First National Bank"
|
|
2042
2053
|
});
|
|
2043
2054
|
|
|
2044
2055
|
```
|
|
@@ -2055,7 +2066,7 @@ await client.transfers.initiateInternal({
|
|
|
2055
2066
|
<dl>
|
|
2056
2067
|
<dd>
|
|
2057
2068
|
|
|
2058
|
-
**request:** `Natural.
|
|
2069
|
+
**request:** `Natural.NewExtPartyAcctParams`
|
|
2059
2070
|
|
|
2060
2071
|
</dd>
|
|
2061
2072
|
</dl>
|
|
@@ -2063,7 +2074,7 @@ await client.transfers.initiateInternal({
|
|
|
2063
2074
|
<dl>
|
|
2064
2075
|
<dd>
|
|
2065
2076
|
|
|
2066
|
-
**requestOptions:** `
|
|
2077
|
+
**requestOptions:** `ExternalPartyAccountsClient.RequestOptions`
|
|
2067
2078
|
|
|
2068
2079
|
</dd>
|
|
2069
2080
|
</dl>
|
|
@@ -2075,7 +2086,7 @@ await client.transfers.initiateInternal({
|
|
|
2075
2086
|
</dl>
|
|
2076
2087
|
</details>
|
|
2077
2088
|
|
|
2078
|
-
<details><summary><code>client.
|
|
2089
|
+
<details><summary><code>client.externalPartyAccounts.<a href="/src/api/resources/externalPartyAccounts/client/Client.ts">get</a>({ ...params }) -> Natural.ExtPartyAcctDetail</code></summary>
|
|
2079
2090
|
<dl>
|
|
2080
2091
|
<dd>
|
|
2081
2092
|
|
|
@@ -2087,7 +2098,7 @@ await client.transfers.initiateInternal({
|
|
|
2087
2098
|
<dl>
|
|
2088
2099
|
<dd>
|
|
2089
2100
|
|
|
2090
|
-
|
|
2101
|
+
Get an external party account by ID
|
|
2091
2102
|
</dd>
|
|
2092
2103
|
</dl>
|
|
2093
2104
|
</dd>
|
|
@@ -2102,19 +2113,9 @@ List transfers
|
|
|
2102
2113
|
<dd>
|
|
2103
2114
|
|
|
2104
2115
|
```typescript
|
|
2105
|
-
|
|
2106
|
-
|
|
2107
|
-
|
|
2108
|
-
}
|
|
2109
|
-
|
|
2110
|
-
// Or you can manually iterate page-by-page
|
|
2111
|
-
let page = await client.transfers.list();
|
|
2112
|
-
while (page.hasNextPage()) {
|
|
2113
|
-
page = page.getNextPage();
|
|
2114
|
-
}
|
|
2115
|
-
|
|
2116
|
-
// You can also access the underlying response
|
|
2117
|
-
const response = page.response;
|
|
2116
|
+
await client.externalPartyAccounts.get({
|
|
2117
|
+
externalPartyAccountId: "externalPartyAccountId"
|
|
2118
|
+
});
|
|
2118
2119
|
|
|
2119
2120
|
```
|
|
2120
2121
|
</dd>
|
|
@@ -2130,7 +2131,7 @@ const response = page.response;
|
|
|
2130
2131
|
<dl>
|
|
2131
2132
|
<dd>
|
|
2132
2133
|
|
|
2133
|
-
**request:** `Natural.
|
|
2134
|
+
**request:** `Natural.GetExternalPartyAccountsRequest`
|
|
2134
2135
|
|
|
2135
2136
|
</dd>
|
|
2136
2137
|
</dl>
|
|
@@ -2138,7 +2139,7 @@ const response = page.response;
|
|
|
2138
2139
|
<dl>
|
|
2139
2140
|
<dd>
|
|
2140
2141
|
|
|
2141
|
-
**requestOptions:** `
|
|
2142
|
+
**requestOptions:** `ExternalPartyAccountsClient.RequestOptions`
|
|
2142
2143
|
|
|
2143
2144
|
</dd>
|
|
2144
2145
|
</dl>
|
|
@@ -2150,7 +2151,8 @@ const response = page.response;
|
|
|
2150
2151
|
</dl>
|
|
2151
2152
|
</details>
|
|
2152
2153
|
|
|
2153
|
-
|
|
2154
|
+
## ACH
|
|
2155
|
+
<details><summary><code>client.ach.<a href="/src/api/resources/ach/client/Client.ts">list</a>({ ...params }) -> core.Page<Natural.ListAchResponseDataItem, Natural.Ach></code></summary>
|
|
2154
2156
|
<dl>
|
|
2155
2157
|
<dd>
|
|
2156
2158
|
|
|
@@ -2162,7 +2164,7 @@ const response = page.response;
|
|
|
2162
2164
|
<dl>
|
|
2163
2165
|
<dd>
|
|
2164
2166
|
|
|
2165
|
-
|
|
2167
|
+
List your ACH payments
|
|
2166
2168
|
</dd>
|
|
2167
2169
|
</dl>
|
|
2168
2170
|
</dd>
|
|
@@ -2177,9 +2179,19 @@ Get a transfer
|
|
|
2177
2179
|
<dd>
|
|
2178
2180
|
|
|
2179
2181
|
```typescript
|
|
2180
|
-
await client.
|
|
2181
|
-
|
|
2182
|
-
|
|
2182
|
+
const pageableResponse = await client.ach.list();
|
|
2183
|
+
for await (const item of pageableResponse) {
|
|
2184
|
+
console.log(item);
|
|
2185
|
+
}
|
|
2186
|
+
|
|
2187
|
+
// Or you can manually iterate page-by-page
|
|
2188
|
+
let page = await client.ach.list();
|
|
2189
|
+
while (page.hasNextPage()) {
|
|
2190
|
+
page = page.getNextPage();
|
|
2191
|
+
}
|
|
2192
|
+
|
|
2193
|
+
// You can also access the underlying response
|
|
2194
|
+
const response = page.response;
|
|
2183
2195
|
|
|
2184
2196
|
```
|
|
2185
2197
|
</dd>
|
|
@@ -2195,7 +2207,7 @@ await client.transfers.get({
|
|
|
2195
2207
|
<dl>
|
|
2196
2208
|
<dd>
|
|
2197
2209
|
|
|
2198
|
-
**request:** `Natural.
|
|
2210
|
+
**request:** `Natural.ListAchRequest`
|
|
2199
2211
|
|
|
2200
2212
|
</dd>
|
|
2201
2213
|
</dl>
|
|
@@ -2203,7 +2215,7 @@ await client.transfers.get({
|
|
|
2203
2215
|
<dl>
|
|
2204
2216
|
<dd>
|
|
2205
2217
|
|
|
2206
|
-
**requestOptions:** `
|
|
2218
|
+
**requestOptions:** `AchClient.RequestOptions`
|
|
2207
2219
|
|
|
2208
2220
|
</dd>
|
|
2209
2221
|
</dl>
|
|
@@ -2215,8 +2227,7 @@ await client.transfers.get({
|
|
|
2215
2227
|
</dl>
|
|
2216
2228
|
</details>
|
|
2217
2229
|
|
|
2218
|
-
|
|
2219
|
-
<details><summary><code>client.paymentRequests.<a href="/src/api/resources/paymentRequests/client/Client.ts">list</a>({ ...params }) -> core.Page<Natural.ListPaymentRequestsResponseDataItem, Natural.PayReq></code></summary>
|
|
2230
|
+
<details><summary><code>client.ach.<a href="/src/api/resources/ach/client/Client.ts">create</a>({ ...params }) -> Natural.NewAch</code></summary>
|
|
2220
2231
|
<dl>
|
|
2221
2232
|
<dd>
|
|
2222
2233
|
|
|
@@ -2228,7 +2239,7 @@ await client.transfers.get({
|
|
|
2228
2239
|
<dl>
|
|
2229
2240
|
<dd>
|
|
2230
2241
|
|
|
2231
|
-
|
|
2242
|
+
Create an ACH payment to an external party account
|
|
2232
2243
|
</dd>
|
|
2233
2244
|
</dl>
|
|
2234
2245
|
</dd>
|
|
@@ -2243,19 +2254,14 @@ List outgoing payment requests
|
|
|
2243
2254
|
<dd>
|
|
2244
2255
|
|
|
2245
2256
|
```typescript
|
|
2246
|
-
|
|
2247
|
-
|
|
2248
|
-
|
|
2249
|
-
|
|
2250
|
-
|
|
2251
|
-
|
|
2252
|
-
|
|
2253
|
-
|
|
2254
|
-
page = page.getNextPage();
|
|
2255
|
-
}
|
|
2256
|
-
|
|
2257
|
-
// You can also access the underlying response
|
|
2258
|
-
const response = page.response;
|
|
2257
|
+
await client.ach.create({
|
|
2258
|
+
idempotencyKey: "Idempotency-Key",
|
|
2259
|
+
direction: "credit",
|
|
2260
|
+
amount: 25000,
|
|
2261
|
+
currency: "USD",
|
|
2262
|
+
externalPartyAccountId: "epa_550e8400e29b41d4a716446655440000",
|
|
2263
|
+
companyEntryDescription: "PAYOUT"
|
|
2264
|
+
});
|
|
2259
2265
|
|
|
2260
2266
|
```
|
|
2261
2267
|
</dd>
|
|
@@ -2271,7 +2277,7 @@ const response = page.response;
|
|
|
2271
2277
|
<dl>
|
|
2272
2278
|
<dd>
|
|
2273
2279
|
|
|
2274
|
-
**request:** `Natural.
|
|
2280
|
+
**request:** `Natural.NewAchParams`
|
|
2275
2281
|
|
|
2276
2282
|
</dd>
|
|
2277
2283
|
</dl>
|
|
@@ -2279,7 +2285,7 @@ const response = page.response;
|
|
|
2279
2285
|
<dl>
|
|
2280
2286
|
<dd>
|
|
2281
2287
|
|
|
2282
|
-
**requestOptions:** `
|
|
2288
|
+
**requestOptions:** `AchClient.RequestOptions`
|
|
2283
2289
|
|
|
2284
2290
|
</dd>
|
|
2285
2291
|
</dl>
|
|
@@ -2291,7 +2297,7 @@ const response = page.response;
|
|
|
2291
2297
|
</dl>
|
|
2292
2298
|
</details>
|
|
2293
2299
|
|
|
2294
|
-
<details><summary><code>client.
|
|
2300
|
+
<details><summary><code>client.ach.<a href="/src/api/resources/ach/client/Client.ts">get</a>({ ...params }) -> Natural.AchDetail</code></summary>
|
|
2295
2301
|
<dl>
|
|
2296
2302
|
<dd>
|
|
2297
2303
|
|
|
@@ -2303,7 +2309,7 @@ const response = page.response;
|
|
|
2303
2309
|
<dl>
|
|
2304
2310
|
<dd>
|
|
2305
2311
|
|
|
2306
|
-
|
|
2312
|
+
Get an ACH payment
|
|
2307
2313
|
</dd>
|
|
2308
2314
|
</dl>
|
|
2309
2315
|
</dd>
|
|
@@ -2318,19 +2324,8 @@ Create a payment request
|
|
|
2318
2324
|
<dd>
|
|
2319
2325
|
|
|
2320
2326
|
```typescript
|
|
2321
|
-
await client.
|
|
2322
|
-
|
|
2323
|
-
amount: 2500,
|
|
2324
|
-
currency: "USD",
|
|
2325
|
-
description: "Invoice 7",
|
|
2326
|
-
tags: {
|
|
2327
|
-
"invoice_id": "inv_7"
|
|
2328
|
-
},
|
|
2329
|
-
payerName: "Ada Lovelace",
|
|
2330
|
-
payer: {
|
|
2331
|
-
type: "email",
|
|
2332
|
-
value: "ada@example.com"
|
|
2333
|
-
}
|
|
2327
|
+
await client.ach.get({
|
|
2328
|
+
achId: "achId"
|
|
2334
2329
|
});
|
|
2335
2330
|
|
|
2336
2331
|
```
|
|
@@ -2347,7 +2342,7 @@ await client.paymentRequests.create({
|
|
|
2347
2342
|
<dl>
|
|
2348
2343
|
<dd>
|
|
2349
2344
|
|
|
2350
|
-
**request:** `Natural.
|
|
2345
|
+
**request:** `Natural.GetAchRequest`
|
|
2351
2346
|
|
|
2352
2347
|
</dd>
|
|
2353
2348
|
</dl>
|
|
@@ -2355,7 +2350,7 @@ await client.paymentRequests.create({
|
|
|
2355
2350
|
<dl>
|
|
2356
2351
|
<dd>
|
|
2357
2352
|
|
|
2358
|
-
**requestOptions:** `
|
|
2353
|
+
**requestOptions:** `AchClient.RequestOptions`
|
|
2359
2354
|
|
|
2360
2355
|
</dd>
|
|
2361
2356
|
</dl>
|
|
@@ -2367,7 +2362,7 @@ await client.paymentRequests.create({
|
|
|
2367
2362
|
</dl>
|
|
2368
2363
|
</details>
|
|
2369
2364
|
|
|
2370
|
-
<details><summary><code>client.
|
|
2365
|
+
<details><summary><code>client.ach.<a href="/src/api/resources/ach/client/Client.ts">cancel</a>({ ...params }) -> Natural.CancelledAch</code></summary>
|
|
2371
2366
|
<dl>
|
|
2372
2367
|
<dd>
|
|
2373
2368
|
|
|
@@ -2379,7 +2374,7 @@ await client.paymentRequests.create({
|
|
|
2379
2374
|
<dl>
|
|
2380
2375
|
<dd>
|
|
2381
2376
|
|
|
2382
|
-
|
|
2377
|
+
Cancel an ACH payment before submission
|
|
2383
2378
|
</dd>
|
|
2384
2379
|
</dl>
|
|
2385
2380
|
</dd>
|
|
@@ -2394,19 +2389,11 @@ List incoming payment requests
|
|
|
2394
2389
|
<dd>
|
|
2395
2390
|
|
|
2396
2391
|
```typescript
|
|
2397
|
-
|
|
2398
|
-
|
|
2399
|
-
|
|
2400
|
-
|
|
2401
|
-
|
|
2402
|
-
// Or you can manually iterate page-by-page
|
|
2403
|
-
let page = await client.paymentRequests.listIncoming();
|
|
2404
|
-
while (page.hasNextPage()) {
|
|
2405
|
-
page = page.getNextPage();
|
|
2406
|
-
}
|
|
2407
|
-
|
|
2408
|
-
// You can also access the underlying response
|
|
2409
|
-
const response = page.response;
|
|
2392
|
+
await client.ach.cancel({
|
|
2393
|
+
idempotencyKey: "Idempotency-Key",
|
|
2394
|
+
achId: "achId",
|
|
2395
|
+
reason: "Duplicate payout"
|
|
2396
|
+
});
|
|
2410
2397
|
|
|
2411
2398
|
```
|
|
2412
2399
|
</dd>
|
|
@@ -2422,7 +2409,7 @@ const response = page.response;
|
|
|
2422
2409
|
<dl>
|
|
2423
2410
|
<dd>
|
|
2424
2411
|
|
|
2425
|
-
**request:** `Natural.
|
|
2412
|
+
**request:** `Natural.CancelAchParams`
|
|
2426
2413
|
|
|
2427
2414
|
</dd>
|
|
2428
2415
|
</dl>
|
|
@@ -2430,7 +2417,7 @@ const response = page.response;
|
|
|
2430
2417
|
<dl>
|
|
2431
2418
|
<dd>
|
|
2432
2419
|
|
|
2433
|
-
**requestOptions:** `
|
|
2420
|
+
**requestOptions:** `AchClient.RequestOptions`
|
|
2434
2421
|
|
|
2435
2422
|
</dd>
|
|
2436
2423
|
</dl>
|
|
@@ -2442,7 +2429,8 @@ const response = page.response;
|
|
|
2442
2429
|
</dl>
|
|
2443
2430
|
</details>
|
|
2444
2431
|
|
|
2445
|
-
|
|
2432
|
+
## Realtime
|
|
2433
|
+
<details><summary><code>client.realtime.<a href="/src/api/resources/realtime/client/Client.ts">list</a>({ ...params }) -> Natural.ListRealtimeResponse</code></summary>
|
|
2446
2434
|
<dl>
|
|
2447
2435
|
<dd>
|
|
2448
2436
|
|
|
@@ -2454,7 +2442,7 @@ const response = page.response;
|
|
|
2454
2442
|
<dl>
|
|
2455
2443
|
<dd>
|
|
2456
2444
|
|
|
2457
|
-
|
|
2445
|
+
List your realtime payments
|
|
2458
2446
|
</dd>
|
|
2459
2447
|
</dl>
|
|
2460
2448
|
</dd>
|
|
@@ -2469,9 +2457,7 @@ Get a payment request
|
|
|
2469
2457
|
<dd>
|
|
2470
2458
|
|
|
2471
2459
|
```typescript
|
|
2472
|
-
await client.
|
|
2473
|
-
paymentRequestId: "paymentRequestId"
|
|
2474
|
-
});
|
|
2460
|
+
await client.realtime.list();
|
|
2475
2461
|
|
|
2476
2462
|
```
|
|
2477
2463
|
</dd>
|
|
@@ -2487,7 +2473,7 @@ await client.paymentRequests.get({
|
|
|
2487
2473
|
<dl>
|
|
2488
2474
|
<dd>
|
|
2489
2475
|
|
|
2490
|
-
**request:** `Natural.
|
|
2476
|
+
**request:** `Natural.ListRealtimeRequest`
|
|
2491
2477
|
|
|
2492
2478
|
</dd>
|
|
2493
2479
|
</dl>
|
|
@@ -2495,7 +2481,7 @@ await client.paymentRequests.get({
|
|
|
2495
2481
|
<dl>
|
|
2496
2482
|
<dd>
|
|
2497
2483
|
|
|
2498
|
-
**requestOptions:** `
|
|
2484
|
+
**requestOptions:** `RealtimeClient.RequestOptions`
|
|
2499
2485
|
|
|
2500
2486
|
</dd>
|
|
2501
2487
|
</dl>
|
|
@@ -2507,7 +2493,7 @@ await client.paymentRequests.get({
|
|
|
2507
2493
|
</dl>
|
|
2508
2494
|
</details>
|
|
2509
2495
|
|
|
2510
|
-
<details><summary><code>client.
|
|
2496
|
+
<details><summary><code>client.realtime.<a href="/src/api/resources/realtime/client/Client.ts">create</a>({ ...params }) -> Natural.CreateRealtimeResponse</code></summary>
|
|
2511
2497
|
<dl>
|
|
2512
2498
|
<dd>
|
|
2513
2499
|
|
|
@@ -2519,7 +2505,7 @@ await client.paymentRequests.get({
|
|
|
2519
2505
|
<dl>
|
|
2520
2506
|
<dd>
|
|
2521
2507
|
|
|
2522
|
-
|
|
2508
|
+
Create a realtime payment to an external party account
|
|
2523
2509
|
</dd>
|
|
2524
2510
|
</dl>
|
|
2525
2511
|
</dd>
|
|
@@ -2534,16 +2520,12 @@ Fulfill an open payment request from a wallet or a verified linked bank account
|
|
|
2534
2520
|
<dd>
|
|
2535
2521
|
|
|
2536
2522
|
```typescript
|
|
2537
|
-
await client.
|
|
2523
|
+
await client.realtime.create({
|
|
2538
2524
|
idempotencyKey: "Idempotency-Key",
|
|
2539
|
-
|
|
2540
|
-
|
|
2541
|
-
|
|
2542
|
-
|
|
2543
|
-
},
|
|
2544
|
-
tags: {
|
|
2545
|
-
"invoice_id": "inv_7"
|
|
2546
|
-
}
|
|
2525
|
+
amount: 25000,
|
|
2526
|
+
currency: "USD",
|
|
2527
|
+
externalPartyAccountId: "epa_550e8400e29b41d4a716446655440000",
|
|
2528
|
+
description: "Invoice 1042 settlement"
|
|
2547
2529
|
});
|
|
2548
2530
|
|
|
2549
2531
|
```
|
|
@@ -2560,7 +2542,7 @@ await client.paymentRequests.fulfill({
|
|
|
2560
2542
|
<dl>
|
|
2561
2543
|
<dd>
|
|
2562
2544
|
|
|
2563
|
-
**request:** `Natural.
|
|
2545
|
+
**request:** `Natural.CreateRealtimeRequest`
|
|
2564
2546
|
|
|
2565
2547
|
</dd>
|
|
2566
2548
|
</dl>
|
|
@@ -2568,7 +2550,7 @@ await client.paymentRequests.fulfill({
|
|
|
2568
2550
|
<dl>
|
|
2569
2551
|
<dd>
|
|
2570
2552
|
|
|
2571
|
-
**requestOptions:** `
|
|
2553
|
+
**requestOptions:** `RealtimeClient.RequestOptions`
|
|
2572
2554
|
|
|
2573
2555
|
</dd>
|
|
2574
2556
|
</dl>
|
|
@@ -2580,7 +2562,7 @@ await client.paymentRequests.fulfill({
|
|
|
2580
2562
|
</dl>
|
|
2581
2563
|
</details>
|
|
2582
2564
|
|
|
2583
|
-
<details><summary><code>client.
|
|
2565
|
+
<details><summary><code>client.realtime.<a href="/src/api/resources/realtime/client/Client.ts">get</a>({ ...params }) -> Natural.GetRealtimeResponse</code></summary>
|
|
2584
2566
|
<dl>
|
|
2585
2567
|
<dd>
|
|
2586
2568
|
|
|
@@ -2592,7 +2574,7 @@ await client.paymentRequests.fulfill({
|
|
|
2592
2574
|
<dl>
|
|
2593
2575
|
<dd>
|
|
2594
2576
|
|
|
2595
|
-
|
|
2577
|
+
Get a realtime payment
|
|
2596
2578
|
</dd>
|
|
2597
2579
|
</dl>
|
|
2598
2580
|
</dd>
|
|
@@ -2607,9 +2589,8 @@ Decline an open incoming payment request
|
|
|
2607
2589
|
<dd>
|
|
2608
2590
|
|
|
2609
2591
|
```typescript
|
|
2610
|
-
await client.
|
|
2611
|
-
|
|
2612
|
-
paymentRequestId: "paymentRequestId"
|
|
2592
|
+
await client.realtime.get({
|
|
2593
|
+
realtimeId: "realtimeId"
|
|
2613
2594
|
});
|
|
2614
2595
|
|
|
2615
2596
|
```
|
|
@@ -2626,7 +2607,7 @@ await client.paymentRequests.decline({
|
|
|
2626
2607
|
<dl>
|
|
2627
2608
|
<dd>
|
|
2628
2609
|
|
|
2629
|
-
**request:** `Natural.
|
|
2610
|
+
**request:** `Natural.GetRealtimeRequest`
|
|
2630
2611
|
|
|
2631
2612
|
</dd>
|
|
2632
2613
|
</dl>
|
|
@@ -2634,7 +2615,7 @@ await client.paymentRequests.decline({
|
|
|
2634
2615
|
<dl>
|
|
2635
2616
|
<dd>
|
|
2636
2617
|
|
|
2637
|
-
**requestOptions:** `
|
|
2618
|
+
**requestOptions:** `RealtimeClient.RequestOptions`
|
|
2638
2619
|
|
|
2639
2620
|
</dd>
|
|
2640
2621
|
</dl>
|
|
@@ -2646,7 +2627,7 @@ await client.paymentRequests.decline({
|
|
|
2646
2627
|
</dl>
|
|
2647
2628
|
</details>
|
|
2648
2629
|
|
|
2649
|
-
<details><summary><code>client.
|
|
2630
|
+
<details><summary><code>client.realtime.<a href="/src/api/resources/realtime/client/Client.ts">cancel</a>({ ...params }) -> Natural.CancelRealtimeResponse</code></summary>
|
|
2650
2631
|
<dl>
|
|
2651
2632
|
<dd>
|
|
2652
2633
|
|
|
@@ -2658,7 +2639,7 @@ await client.paymentRequests.decline({
|
|
|
2658
2639
|
<dl>
|
|
2659
2640
|
<dd>
|
|
2660
2641
|
|
|
2661
|
-
Cancel
|
|
2642
|
+
Cancel a realtime payment before submission
|
|
2662
2643
|
</dd>
|
|
2663
2644
|
</dl>
|
|
2664
2645
|
</dd>
|
|
@@ -2673,9 +2654,10 @@ Cancel an open outgoing payment request
|
|
|
2673
2654
|
<dd>
|
|
2674
2655
|
|
|
2675
2656
|
```typescript
|
|
2676
|
-
await client.
|
|
2657
|
+
await client.realtime.cancel({
|
|
2677
2658
|
idempotencyKey: "Idempotency-Key",
|
|
2678
|
-
|
|
2659
|
+
realtimeId: "realtimeId",
|
|
2660
|
+
reason: "Duplicate payment"
|
|
2679
2661
|
});
|
|
2680
2662
|
|
|
2681
2663
|
```
|
|
@@ -2692,7 +2674,7 @@ await client.paymentRequests.cancel({
|
|
|
2692
2674
|
<dl>
|
|
2693
2675
|
<dd>
|
|
2694
2676
|
|
|
2695
|
-
**request:** `Natural.
|
|
2677
|
+
**request:** `Natural.CancelRealtimeRequest`
|
|
2696
2678
|
|
|
2697
2679
|
</dd>
|
|
2698
2680
|
</dl>
|
|
@@ -2700,7 +2682,7 @@ await client.paymentRequests.cancel({
|
|
|
2700
2682
|
<dl>
|
|
2701
2683
|
<dd>
|
|
2702
2684
|
|
|
2703
|
-
**requestOptions:** `
|
|
2685
|
+
**requestOptions:** `RealtimeClient.RequestOptions`
|
|
2704
2686
|
|
|
2705
2687
|
</dd>
|
|
2706
2688
|
</dl>
|
|
@@ -2712,8 +2694,8 @@ await client.paymentRequests.cancel({
|
|
|
2712
2694
|
</dl>
|
|
2713
2695
|
</details>
|
|
2714
2696
|
|
|
2715
|
-
##
|
|
2716
|
-
<details><summary><code>client.
|
|
2697
|
+
## Transactions
|
|
2698
|
+
<details><summary><code>client.transactions.<a href="/src/api/resources/transactions/client/Client.ts">list</a>({ ...params }) -> core.Page<Natural.ListTransactionsResponseDataItem, Natural.Txn></code></summary>
|
|
2717
2699
|
<dl>
|
|
2718
2700
|
<dd>
|
|
2719
2701
|
|
|
@@ -2725,7 +2707,7 @@ await client.paymentRequests.cancel({
|
|
|
2725
2707
|
<dl>
|
|
2726
2708
|
<dd>
|
|
2727
2709
|
|
|
2728
|
-
List
|
|
2710
|
+
List transactions
|
|
2729
2711
|
</dd>
|
|
2730
2712
|
</dl>
|
|
2731
2713
|
</dd>
|
|
@@ -2740,7 +2722,19 @@ List approvals
|
|
|
2740
2722
|
<dd>
|
|
2741
2723
|
|
|
2742
2724
|
```typescript
|
|
2743
|
-
await client.
|
|
2725
|
+
const pageableResponse = await client.transactions.list();
|
|
2726
|
+
for await (const item of pageableResponse) {
|
|
2727
|
+
console.log(item);
|
|
2728
|
+
}
|
|
2729
|
+
|
|
2730
|
+
// Or you can manually iterate page-by-page
|
|
2731
|
+
let page = await client.transactions.list();
|
|
2732
|
+
while (page.hasNextPage()) {
|
|
2733
|
+
page = page.getNextPage();
|
|
2734
|
+
}
|
|
2735
|
+
|
|
2736
|
+
// You can also access the underlying response
|
|
2737
|
+
const response = page.response;
|
|
2744
2738
|
|
|
2745
2739
|
```
|
|
2746
2740
|
</dd>
|
|
@@ -2756,7 +2750,7 @@ await client.approvals.list();
|
|
|
2756
2750
|
<dl>
|
|
2757
2751
|
<dd>
|
|
2758
2752
|
|
|
2759
|
-
**request:** `Natural.
|
|
2753
|
+
**request:** `Natural.ListTransactionsRequest`
|
|
2760
2754
|
|
|
2761
2755
|
</dd>
|
|
2762
2756
|
</dl>
|
|
@@ -2764,7 +2758,7 @@ await client.approvals.list();
|
|
|
2764
2758
|
<dl>
|
|
2765
2759
|
<dd>
|
|
2766
2760
|
|
|
2767
|
-
**requestOptions:** `
|
|
2761
|
+
**requestOptions:** `TransactionsClient.RequestOptions`
|
|
2768
2762
|
|
|
2769
2763
|
</dd>
|
|
2770
2764
|
</dl>
|
|
@@ -2776,7 +2770,7 @@ await client.approvals.list();
|
|
|
2776
2770
|
</dl>
|
|
2777
2771
|
</details>
|
|
2778
2772
|
|
|
2779
|
-
<details><summary><code>client.
|
|
2773
|
+
<details><summary><code>client.transactions.<a href="/src/api/resources/transactions/client/Client.ts">get</a>({ ...params }) -> Natural.TxnDetail</code></summary>
|
|
2780
2774
|
<dl>
|
|
2781
2775
|
<dd>
|
|
2782
2776
|
|
|
@@ -2788,7 +2782,7 @@ await client.approvals.list();
|
|
|
2788
2782
|
<dl>
|
|
2789
2783
|
<dd>
|
|
2790
2784
|
|
|
2791
|
-
Get
|
|
2785
|
+
Get a transaction
|
|
2792
2786
|
</dd>
|
|
2793
2787
|
</dl>
|
|
2794
2788
|
</dd>
|
|
@@ -2803,8 +2797,8 @@ Get an approval
|
|
|
2803
2797
|
<dd>
|
|
2804
2798
|
|
|
2805
2799
|
```typescript
|
|
2806
|
-
await client.
|
|
2807
|
-
|
|
2800
|
+
await client.transactions.get({
|
|
2801
|
+
transactionId: "transactionId"
|
|
2808
2802
|
});
|
|
2809
2803
|
|
|
2810
2804
|
```
|
|
@@ -2821,7 +2815,7 @@ await client.approvals.get({
|
|
|
2821
2815
|
<dl>
|
|
2822
2816
|
<dd>
|
|
2823
2817
|
|
|
2824
|
-
**request:** `Natural.
|
|
2818
|
+
**request:** `Natural.GetTransactionsRequest`
|
|
2825
2819
|
|
|
2826
2820
|
</dd>
|
|
2827
2821
|
</dl>
|
|
@@ -2829,7 +2823,7 @@ await client.approvals.get({
|
|
|
2829
2823
|
<dl>
|
|
2830
2824
|
<dd>
|
|
2831
2825
|
|
|
2832
|
-
**requestOptions:** `
|
|
2826
|
+
**requestOptions:** `TransactionsClient.RequestOptions`
|
|
2833
2827
|
|
|
2834
2828
|
</dd>
|
|
2835
2829
|
</dl>
|
|
@@ -2841,7 +2835,8 @@ await client.approvals.get({
|
|
|
2841
2835
|
</dl>
|
|
2842
2836
|
</details>
|
|
2843
2837
|
|
|
2844
|
-
|
|
2838
|
+
## Transfers
|
|
2839
|
+
<details><summary><code>client.transfers.<a href="/src/api/resources/transfers/client/Client.ts">initiateDeposit</a>({ ...params }) -> Natural.Deposit</code></summary>
|
|
2845
2840
|
<dl>
|
|
2846
2841
|
<dd>
|
|
2847
2842
|
|
|
@@ -2853,7 +2848,7 @@ await client.approvals.get({
|
|
|
2853
2848
|
<dl>
|
|
2854
2849
|
<dd>
|
|
2855
2850
|
|
|
2856
|
-
|
|
2851
|
+
Move funds from a linked bank account into a wallet
|
|
2857
2852
|
</dd>
|
|
2858
2853
|
</dl>
|
|
2859
2854
|
</dd>
|
|
@@ -2868,9 +2863,15 @@ Approve the payment or transfer under review
|
|
|
2868
2863
|
<dd>
|
|
2869
2864
|
|
|
2870
2865
|
```typescript
|
|
2871
|
-
await client.
|
|
2866
|
+
await client.transfers.initiateDeposit({
|
|
2872
2867
|
idempotencyKey: "Idempotency-Key",
|
|
2873
|
-
|
|
2868
|
+
amount: 50000,
|
|
2869
|
+
currency: "USD",
|
|
2870
|
+
externalAccountId: "eac_550e8400e29b41d4a716446655440000",
|
|
2871
|
+
description: "Wallet top-up",
|
|
2872
|
+
tags: {
|
|
2873
|
+
"workflow": "treasury"
|
|
2874
|
+
}
|
|
2874
2875
|
});
|
|
2875
2876
|
|
|
2876
2877
|
```
|
|
@@ -2887,7 +2888,7 @@ await client.approvals.approve({
|
|
|
2887
2888
|
<dl>
|
|
2888
2889
|
<dd>
|
|
2889
2890
|
|
|
2890
|
-
**request:** `Natural.
|
|
2891
|
+
**request:** `Natural.NewDepositParams`
|
|
2891
2892
|
|
|
2892
2893
|
</dd>
|
|
2893
2894
|
</dl>
|
|
@@ -2895,7 +2896,7 @@ await client.approvals.approve({
|
|
|
2895
2896
|
<dl>
|
|
2896
2897
|
<dd>
|
|
2897
2898
|
|
|
2898
|
-
**requestOptions:** `
|
|
2899
|
+
**requestOptions:** `TransfersClient.RequestOptions`
|
|
2899
2900
|
|
|
2900
2901
|
</dd>
|
|
2901
2902
|
</dl>
|
|
@@ -2907,7 +2908,7 @@ await client.approvals.approve({
|
|
|
2907
2908
|
</dl>
|
|
2908
2909
|
</details>
|
|
2909
2910
|
|
|
2910
|
-
<details><summary><code>client.
|
|
2911
|
+
<details><summary><code>client.transfers.<a href="/src/api/resources/transfers/client/Client.ts">initiateWithdrawal</a>({ ...params }) -> Natural.Withdrawal</code></summary>
|
|
2911
2912
|
<dl>
|
|
2912
2913
|
<dd>
|
|
2913
2914
|
|
|
@@ -2919,7 +2920,7 @@ await client.approvals.approve({
|
|
|
2919
2920
|
<dl>
|
|
2920
2921
|
<dd>
|
|
2921
2922
|
|
|
2922
|
-
|
|
2923
|
+
Move funds from a wallet to a linked bank account
|
|
2923
2924
|
</dd>
|
|
2924
2925
|
</dl>
|
|
2925
2926
|
</dd>
|
|
@@ -2934,10 +2935,16 @@ Deny the payment or transfer under review
|
|
|
2934
2935
|
<dd>
|
|
2935
2936
|
|
|
2936
2937
|
```typescript
|
|
2937
|
-
await client.
|
|
2938
|
+
await client.transfers.initiateWithdrawal({
|
|
2938
2939
|
idempotencyKey: "Idempotency-Key",
|
|
2939
|
-
|
|
2940
|
-
|
|
2940
|
+
amount: 12500,
|
|
2941
|
+
currency: "USD",
|
|
2942
|
+
externalAccountId: "eac_550e8400e29b41d4a716446655440000",
|
|
2943
|
+
method: "standard",
|
|
2944
|
+
description: "Payout transfer",
|
|
2945
|
+
tags: {
|
|
2946
|
+
"workflow": "treasury"
|
|
2947
|
+
}
|
|
2941
2948
|
});
|
|
2942
2949
|
|
|
2943
2950
|
```
|
|
@@ -2954,7 +2961,7 @@ await client.approvals.deny({
|
|
|
2954
2961
|
<dl>
|
|
2955
2962
|
<dd>
|
|
2956
2963
|
|
|
2957
|
-
**request:** `Natural.
|
|
2964
|
+
**request:** `Natural.NewWithdrawalParams`
|
|
2958
2965
|
|
|
2959
2966
|
</dd>
|
|
2960
2967
|
</dl>
|
|
@@ -2962,7 +2969,7 @@ await client.approvals.deny({
|
|
|
2962
2969
|
<dl>
|
|
2963
2970
|
<dd>
|
|
2964
2971
|
|
|
2965
|
-
**requestOptions:** `
|
|
2972
|
+
**requestOptions:** `TransfersClient.RequestOptions`
|
|
2966
2973
|
|
|
2967
2974
|
</dd>
|
|
2968
2975
|
</dl>
|
|
@@ -2974,8 +2981,7 @@ await client.approvals.deny({
|
|
|
2974
2981
|
</dl>
|
|
2975
2982
|
</details>
|
|
2976
2983
|
|
|
2977
|
-
|
|
2978
|
-
<details><summary><code>client.invitations.<a href="/src/api/resources/invitations/client/Client.ts">list</a>({ ...params }) -> Natural.ListInvitationsResponse</code></summary>
|
|
2984
|
+
<details><summary><code>client.transfers.<a href="/src/api/resources/transfers/client/Client.ts">initiateInternal</a>({ ...params }) -> Natural.InitiateInternalTransfersResponse</code></summary>
|
|
2979
2985
|
<dl>
|
|
2980
2986
|
<dd>
|
|
2981
2987
|
|
|
@@ -2987,7 +2993,7 @@ await client.approvals.deny({
|
|
|
2987
2993
|
<dl>
|
|
2988
2994
|
<dd>
|
|
2989
2995
|
|
|
2990
|
-
|
|
2996
|
+
Move funds between two wallets
|
|
2991
2997
|
</dd>
|
|
2992
2998
|
</dl>
|
|
2993
2999
|
</dd>
|
|
@@ -3002,7 +3008,16 @@ List party invitations
|
|
|
3002
3008
|
<dd>
|
|
3003
3009
|
|
|
3004
3010
|
```typescript
|
|
3005
|
-
await client.
|
|
3011
|
+
await client.transfers.initiateInternal({
|
|
3012
|
+
idempotencyKey: "Idempotency-Key",
|
|
3013
|
+
amount: 5000,
|
|
3014
|
+
sourceWalletId: "wal_550e8400e29b41d4a716446655440000",
|
|
3015
|
+
destWalletId: "wal_7c9e6679e29b41d4a716446655440002",
|
|
3016
|
+
description: "Sweep to vault",
|
|
3017
|
+
tags: {
|
|
3018
|
+
"workflow": "treasury"
|
|
3019
|
+
}
|
|
3020
|
+
});
|
|
3006
3021
|
|
|
3007
3022
|
```
|
|
3008
3023
|
</dd>
|
|
@@ -3018,7 +3033,7 @@ await client.invitations.list();
|
|
|
3018
3033
|
<dl>
|
|
3019
3034
|
<dd>
|
|
3020
3035
|
|
|
3021
|
-
**request:** `Natural.
|
|
3036
|
+
**request:** `Natural.InitiateInternalTransfersRequest`
|
|
3022
3037
|
|
|
3023
3038
|
</dd>
|
|
3024
3039
|
</dl>
|
|
@@ -3026,7 +3041,7 @@ await client.invitations.list();
|
|
|
3026
3041
|
<dl>
|
|
3027
3042
|
<dd>
|
|
3028
3043
|
|
|
3029
|
-
**requestOptions:** `
|
|
3044
|
+
**requestOptions:** `TransfersClient.RequestOptions`
|
|
3030
3045
|
|
|
3031
3046
|
</dd>
|
|
3032
3047
|
</dl>
|
|
@@ -3038,7 +3053,7 @@ await client.invitations.list();
|
|
|
3038
3053
|
</dl>
|
|
3039
3054
|
</details>
|
|
3040
3055
|
|
|
3041
|
-
<details><summary><code>client.
|
|
3056
|
+
<details><summary><code>client.transfers.<a href="/src/api/resources/transfers/client/Client.ts">list</a>({ ...params }) -> core.Page<Natural.ListTransfersResponseDataItem, Natural.Transfer></code></summary>
|
|
3042
3057
|
<dl>
|
|
3043
3058
|
<dd>
|
|
3044
3059
|
|
|
@@ -3050,7 +3065,7 @@ await client.invitations.list();
|
|
|
3050
3065
|
<dl>
|
|
3051
3066
|
<dd>
|
|
3052
3067
|
|
|
3053
|
-
|
|
3068
|
+
List transfers
|
|
3054
3069
|
</dd>
|
|
3055
3070
|
</dl>
|
|
3056
3071
|
</dd>
|
|
@@ -3065,18 +3080,19 @@ Invite people to join the party. Available for business parties.
|
|
|
3065
3080
|
<dd>
|
|
3066
3081
|
|
|
3067
3082
|
```typescript
|
|
3068
|
-
await client.
|
|
3069
|
-
|
|
3070
|
-
|
|
3071
|
-
|
|
3072
|
-
|
|
3073
|
-
|
|
3074
|
-
|
|
3075
|
-
|
|
3076
|
-
|
|
3077
|
-
|
|
3078
|
-
|
|
3079
|
-
|
|
3083
|
+
const pageableResponse = await client.transfers.list();
|
|
3084
|
+
for await (const item of pageableResponse) {
|
|
3085
|
+
console.log(item);
|
|
3086
|
+
}
|
|
3087
|
+
|
|
3088
|
+
// Or you can manually iterate page-by-page
|
|
3089
|
+
let page = await client.transfers.list();
|
|
3090
|
+
while (page.hasNextPage()) {
|
|
3091
|
+
page = page.getNextPage();
|
|
3092
|
+
}
|
|
3093
|
+
|
|
3094
|
+
// You can also access the underlying response
|
|
3095
|
+
const response = page.response;
|
|
3080
3096
|
|
|
3081
3097
|
```
|
|
3082
3098
|
</dd>
|
|
@@ -3092,7 +3108,7 @@ await client.invitations.create({
|
|
|
3092
3108
|
<dl>
|
|
3093
3109
|
<dd>
|
|
3094
3110
|
|
|
3095
|
-
**request:** `Natural.
|
|
3111
|
+
**request:** `Natural.ListTransfersRequest`
|
|
3096
3112
|
|
|
3097
3113
|
</dd>
|
|
3098
3114
|
</dl>
|
|
@@ -3100,7 +3116,7 @@ await client.invitations.create({
|
|
|
3100
3116
|
<dl>
|
|
3101
3117
|
<dd>
|
|
3102
3118
|
|
|
3103
|
-
**requestOptions:** `
|
|
3119
|
+
**requestOptions:** `TransfersClient.RequestOptions`
|
|
3104
3120
|
|
|
3105
3121
|
</dd>
|
|
3106
3122
|
</dl>
|
|
@@ -3112,7 +3128,7 @@ await client.invitations.create({
|
|
|
3112
3128
|
</dl>
|
|
3113
3129
|
</details>
|
|
3114
3130
|
|
|
3115
|
-
<details><summary><code>client.
|
|
3131
|
+
<details><summary><code>client.transfers.<a href="/src/api/resources/transfers/client/Client.ts">get</a>({ ...params }) -> Natural.TransferDetail</code></summary>
|
|
3116
3132
|
<dl>
|
|
3117
3133
|
<dd>
|
|
3118
3134
|
|
|
@@ -3124,7 +3140,7 @@ await client.invitations.create({
|
|
|
3124
3140
|
<dl>
|
|
3125
3141
|
<dd>
|
|
3126
3142
|
|
|
3127
|
-
|
|
3143
|
+
Get a transfer
|
|
3128
3144
|
</dd>
|
|
3129
3145
|
</dl>
|
|
3130
3146
|
</dd>
|
|
@@ -3139,9 +3155,8 @@ Revoke a pending party invitation
|
|
|
3139
3155
|
<dd>
|
|
3140
3156
|
|
|
3141
3157
|
```typescript
|
|
3142
|
-
await client.
|
|
3143
|
-
|
|
3144
|
-
invitationId: "invitationId"
|
|
3158
|
+
await client.transfers.get({
|
|
3159
|
+
transferId: "transferId"
|
|
3145
3160
|
});
|
|
3146
3161
|
|
|
3147
3162
|
```
|
|
@@ -3158,7 +3173,7 @@ await client.invitations.revoke({
|
|
|
3158
3173
|
<dl>
|
|
3159
3174
|
<dd>
|
|
3160
3175
|
|
|
3161
|
-
**request:** `Natural.
|
|
3176
|
+
**request:** `Natural.GetTransfersRequest`
|
|
3162
3177
|
|
|
3163
3178
|
</dd>
|
|
3164
3179
|
</dl>
|
|
@@ -3166,7 +3181,7 @@ await client.invitations.revoke({
|
|
|
3166
3181
|
<dl>
|
|
3167
3182
|
<dd>
|
|
3168
3183
|
|
|
3169
|
-
**requestOptions:** `
|
|
3184
|
+
**requestOptions:** `TransfersClient.RequestOptions`
|
|
3170
3185
|
|
|
3171
3186
|
</dd>
|
|
3172
3187
|
</dl>
|
|
@@ -3178,8 +3193,8 @@ await client.invitations.revoke({
|
|
|
3178
3193
|
</dl>
|
|
3179
3194
|
</details>
|
|
3180
3195
|
|
|
3181
|
-
##
|
|
3182
|
-
<details><summary><code>client.
|
|
3196
|
+
## PaymentRequests
|
|
3197
|
+
<details><summary><code>client.paymentRequests.<a href="/src/api/resources/paymentRequests/client/Client.ts">list</a>({ ...params }) -> core.Page<Natural.ListPaymentRequestsResponseDataItem, Natural.PayReq></code></summary>
|
|
3183
3198
|
<dl>
|
|
3184
3199
|
<dd>
|
|
3185
3200
|
|
|
@@ -3191,7 +3206,7 @@ await client.invitations.revoke({
|
|
|
3191
3206
|
<dl>
|
|
3192
3207
|
<dd>
|
|
3193
3208
|
|
|
3194
|
-
|
|
3209
|
+
List outgoing payment requests
|
|
3195
3210
|
</dd>
|
|
3196
3211
|
</dl>
|
|
3197
3212
|
</dd>
|
|
@@ -3206,7 +3221,19 @@ Get the current party
|
|
|
3206
3221
|
<dd>
|
|
3207
3222
|
|
|
3208
3223
|
```typescript
|
|
3209
|
-
await client.
|
|
3224
|
+
const pageableResponse = await client.paymentRequests.list();
|
|
3225
|
+
for await (const item of pageableResponse) {
|
|
3226
|
+
console.log(item);
|
|
3227
|
+
}
|
|
3228
|
+
|
|
3229
|
+
// Or you can manually iterate page-by-page
|
|
3230
|
+
let page = await client.paymentRequests.list();
|
|
3231
|
+
while (page.hasNextPage()) {
|
|
3232
|
+
page = page.getNextPage();
|
|
3233
|
+
}
|
|
3234
|
+
|
|
3235
|
+
// You can also access the underlying response
|
|
3236
|
+
const response = page.response;
|
|
3210
3237
|
|
|
3211
3238
|
```
|
|
3212
3239
|
</dd>
|
|
@@ -3222,7 +3249,15 @@ await client.parties.get();
|
|
|
3222
3249
|
<dl>
|
|
3223
3250
|
<dd>
|
|
3224
3251
|
|
|
3225
|
-
**
|
|
3252
|
+
**request:** `Natural.ListPaymentRequestsRequest`
|
|
3253
|
+
|
|
3254
|
+
</dd>
|
|
3255
|
+
</dl>
|
|
3256
|
+
|
|
3257
|
+
<dl>
|
|
3258
|
+
<dd>
|
|
3259
|
+
|
|
3260
|
+
**requestOptions:** `PaymentRequestsClient.RequestOptions`
|
|
3226
3261
|
|
|
3227
3262
|
</dd>
|
|
3228
3263
|
</dl>
|
|
@@ -3234,7 +3269,7 @@ await client.parties.get();
|
|
|
3234
3269
|
</dl>
|
|
3235
3270
|
</details>
|
|
3236
3271
|
|
|
3237
|
-
<details><summary><code>client.
|
|
3272
|
+
<details><summary><code>client.paymentRequests.<a href="/src/api/resources/paymentRequests/client/Client.ts">create</a>({ ...params }) -> Natural.NewPayReq</code></summary>
|
|
3238
3273
|
<dl>
|
|
3239
3274
|
<dd>
|
|
3240
3275
|
|
|
@@ -3246,7 +3281,7 @@ await client.parties.get();
|
|
|
3246
3281
|
<dl>
|
|
3247
3282
|
<dd>
|
|
3248
3283
|
|
|
3249
|
-
|
|
3284
|
+
Create a payment request
|
|
3250
3285
|
</dd>
|
|
3251
3286
|
</dl>
|
|
3252
3287
|
</dd>
|
|
@@ -3261,8 +3296,19 @@ Update the current party
|
|
|
3261
3296
|
<dd>
|
|
3262
3297
|
|
|
3263
3298
|
```typescript
|
|
3264
|
-
await client.
|
|
3265
|
-
|
|
3299
|
+
await client.paymentRequests.create({
|
|
3300
|
+
idempotencyKey: "Idempotency-Key",
|
|
3301
|
+
amount: 2500,
|
|
3302
|
+
currency: "USD",
|
|
3303
|
+
description: "Invoice 7",
|
|
3304
|
+
tags: {
|
|
3305
|
+
"invoice_id": "inv_7"
|
|
3306
|
+
},
|
|
3307
|
+
payerName: "Ada Lovelace",
|
|
3308
|
+
payer: {
|
|
3309
|
+
type: "email",
|
|
3310
|
+
value: "ada@example.com"
|
|
3311
|
+
}
|
|
3266
3312
|
});
|
|
3267
3313
|
|
|
3268
3314
|
```
|
|
@@ -3279,7 +3325,7 @@ await client.parties.update({
|
|
|
3279
3325
|
<dl>
|
|
3280
3326
|
<dd>
|
|
3281
3327
|
|
|
3282
|
-
**request:** `Natural.
|
|
3328
|
+
**request:** `Natural.NewPayReqParams`
|
|
3283
3329
|
|
|
3284
3330
|
</dd>
|
|
3285
3331
|
</dl>
|
|
@@ -3287,7 +3333,7 @@ await client.parties.update({
|
|
|
3287
3333
|
<dl>
|
|
3288
3334
|
<dd>
|
|
3289
3335
|
|
|
3290
|
-
**requestOptions:** `
|
|
3336
|
+
**requestOptions:** `PaymentRequestsClient.RequestOptions`
|
|
3291
3337
|
|
|
3292
3338
|
</dd>
|
|
3293
3339
|
</dl>
|
|
@@ -3299,7 +3345,7 @@ await client.parties.update({
|
|
|
3299
3345
|
</dl>
|
|
3300
3346
|
</details>
|
|
3301
3347
|
|
|
3302
|
-
<details><summary><code>client.
|
|
3348
|
+
<details><summary><code>client.paymentRequests.<a href="/src/api/resources/paymentRequests/client/Client.ts">listIncoming</a>({ ...params }) -> core.Page<Natural.ListIncomingPaymentRequestsResponseDataItem, Natural.IncomingReq></code></summary>
|
|
3303
3349
|
<dl>
|
|
3304
3350
|
<dd>
|
|
3305
3351
|
|
|
@@ -3311,7 +3357,7 @@ await client.parties.update({
|
|
|
3311
3357
|
<dl>
|
|
3312
3358
|
<dd>
|
|
3313
3359
|
|
|
3314
|
-
List
|
|
3360
|
+
List incoming payment requests
|
|
3315
3361
|
</dd>
|
|
3316
3362
|
</dl>
|
|
3317
3363
|
</dd>
|
|
@@ -3326,13 +3372,13 @@ List active members of the party. Available for business parties.
|
|
|
3326
3372
|
<dd>
|
|
3327
3373
|
|
|
3328
3374
|
```typescript
|
|
3329
|
-
const pageableResponse = await client.
|
|
3375
|
+
const pageableResponse = await client.paymentRequests.listIncoming();
|
|
3330
3376
|
for await (const item of pageableResponse) {
|
|
3331
3377
|
console.log(item);
|
|
3332
3378
|
}
|
|
3333
3379
|
|
|
3334
3380
|
// Or you can manually iterate page-by-page
|
|
3335
|
-
let page = await client.
|
|
3381
|
+
let page = await client.paymentRequests.listIncoming();
|
|
3336
3382
|
while (page.hasNextPage()) {
|
|
3337
3383
|
page = page.getNextPage();
|
|
3338
3384
|
}
|
|
@@ -3354,7 +3400,7 @@ const response = page.response;
|
|
|
3354
3400
|
<dl>
|
|
3355
3401
|
<dd>
|
|
3356
3402
|
|
|
3357
|
-
**request:** `Natural.
|
|
3403
|
+
**request:** `Natural.ListIncomingPaymentRequestsRequest`
|
|
3358
3404
|
|
|
3359
3405
|
</dd>
|
|
3360
3406
|
</dl>
|
|
@@ -3362,7 +3408,7 @@ const response = page.response;
|
|
|
3362
3408
|
<dl>
|
|
3363
3409
|
<dd>
|
|
3364
3410
|
|
|
3365
|
-
**requestOptions:** `
|
|
3411
|
+
**requestOptions:** `PaymentRequestsClient.RequestOptions`
|
|
3366
3412
|
|
|
3367
3413
|
</dd>
|
|
3368
3414
|
</dl>
|
|
@@ -3374,7 +3420,7 @@ const response = page.response;
|
|
|
3374
3420
|
</dl>
|
|
3375
3421
|
</details>
|
|
3376
3422
|
|
|
3377
|
-
<details><summary><code>client.
|
|
3423
|
+
<details><summary><code>client.paymentRequests.<a href="/src/api/resources/paymentRequests/client/Client.ts">get</a>({ ...params }) -> Natural.PayReqDetail</code></summary>
|
|
3378
3424
|
<dl>
|
|
3379
3425
|
<dd>
|
|
3380
3426
|
|
|
@@ -3386,7 +3432,7 @@ const response = page.response;
|
|
|
3386
3432
|
<dl>
|
|
3387
3433
|
<dd>
|
|
3388
3434
|
|
|
3389
|
-
Get a
|
|
3435
|
+
Get a payment request
|
|
3390
3436
|
</dd>
|
|
3391
3437
|
</dl>
|
|
3392
3438
|
</dd>
|
|
@@ -3401,8 +3447,8 @@ Get a party's current compliance status
|
|
|
3401
3447
|
<dd>
|
|
3402
3448
|
|
|
3403
3449
|
```typescript
|
|
3404
|
-
await client.
|
|
3405
|
-
|
|
3450
|
+
await client.paymentRequests.get({
|
|
3451
|
+
paymentRequestId: "paymentRequestId"
|
|
3406
3452
|
});
|
|
3407
3453
|
|
|
3408
3454
|
```
|
|
@@ -3419,7 +3465,7 @@ await client.parties.getCompliance({
|
|
|
3419
3465
|
<dl>
|
|
3420
3466
|
<dd>
|
|
3421
3467
|
|
|
3422
|
-
**request:** `Natural.
|
|
3468
|
+
**request:** `Natural.GetPaymentRequestsRequest`
|
|
3423
3469
|
|
|
3424
3470
|
</dd>
|
|
3425
3471
|
</dl>
|
|
@@ -3427,7 +3473,7 @@ await client.parties.getCompliance({
|
|
|
3427
3473
|
<dl>
|
|
3428
3474
|
<dd>
|
|
3429
3475
|
|
|
3430
|
-
**requestOptions:** `
|
|
3476
|
+
**requestOptions:** `PaymentRequestsClient.RequestOptions`
|
|
3431
3477
|
|
|
3432
3478
|
</dd>
|
|
3433
3479
|
</dl>
|
|
@@ -3439,7 +3485,7 @@ await client.parties.getCompliance({
|
|
|
3439
3485
|
</dl>
|
|
3440
3486
|
</details>
|
|
3441
3487
|
|
|
3442
|
-
<details><summary><code>client.
|
|
3488
|
+
<details><summary><code>client.paymentRequests.<a href="/src/api/resources/paymentRequests/client/Client.ts">fulfill</a>({ ...params }) -> Natural.FulfilledReq</code></summary>
|
|
3443
3489
|
<dl>
|
|
3444
3490
|
<dd>
|
|
3445
3491
|
|
|
@@ -3451,7 +3497,7 @@ await client.parties.getCompliance({
|
|
|
3451
3497
|
<dl>
|
|
3452
3498
|
<dd>
|
|
3453
3499
|
|
|
3454
|
-
|
|
3500
|
+
Fulfill an open payment request from a wallet or a verified linked bank account
|
|
3455
3501
|
</dd>
|
|
3456
3502
|
</dl>
|
|
3457
3503
|
</dd>
|
|
@@ -3466,8 +3512,16 @@ Set or rename your party's handle; it can never be cleared
|
|
|
3466
3512
|
<dd>
|
|
3467
3513
|
|
|
3468
3514
|
```typescript
|
|
3469
|
-
await client.
|
|
3470
|
-
|
|
3515
|
+
await client.paymentRequests.fulfill({
|
|
3516
|
+
idempotencyKey: "Idempotency-Key",
|
|
3517
|
+
paymentRequestId: "paymentRequestId",
|
|
3518
|
+
paymentSource: {
|
|
3519
|
+
type: "wallet",
|
|
3520
|
+
walletId: "wal_550e8400e29b41d4a716446655440000"
|
|
3521
|
+
},
|
|
3522
|
+
tags: {
|
|
3523
|
+
"invoice_id": "inv_7"
|
|
3524
|
+
}
|
|
3471
3525
|
});
|
|
3472
3526
|
|
|
3473
3527
|
```
|
|
@@ -3484,7 +3538,7 @@ await client.parties.setHandle({
|
|
|
3484
3538
|
<dl>
|
|
3485
3539
|
<dd>
|
|
3486
3540
|
|
|
3487
|
-
**request:** `Natural.
|
|
3541
|
+
**request:** `Natural.NewFulfilledReqParams`
|
|
3488
3542
|
|
|
3489
3543
|
</dd>
|
|
3490
3544
|
</dl>
|
|
@@ -3492,7 +3546,7 @@ await client.parties.setHandle({
|
|
|
3492
3546
|
<dl>
|
|
3493
3547
|
<dd>
|
|
3494
3548
|
|
|
3495
|
-
**requestOptions:** `
|
|
3549
|
+
**requestOptions:** `PaymentRequestsClient.RequestOptions`
|
|
3496
3550
|
|
|
3497
3551
|
</dd>
|
|
3498
3552
|
</dl>
|
|
@@ -3504,7 +3558,7 @@ await client.parties.setHandle({
|
|
|
3504
3558
|
</dl>
|
|
3505
3559
|
</details>
|
|
3506
3560
|
|
|
3507
|
-
<details><summary><code>client.
|
|
3561
|
+
<details><summary><code>client.paymentRequests.<a href="/src/api/resources/paymentRequests/client/Client.ts">decline</a>({ ...params }) -> Natural.DeclinedReq</code></summary>
|
|
3508
3562
|
<dl>
|
|
3509
3563
|
<dd>
|
|
3510
3564
|
|
|
@@ -3516,7 +3570,7 @@ await client.parties.setHandle({
|
|
|
3516
3570
|
<dl>
|
|
3517
3571
|
<dd>
|
|
3518
3572
|
|
|
3519
|
-
|
|
3573
|
+
Decline an open incoming payment request
|
|
3520
3574
|
</dd>
|
|
3521
3575
|
</dl>
|
|
3522
3576
|
</dd>
|
|
@@ -3531,7 +3585,10 @@ Get the party's approval limits
|
|
|
3531
3585
|
<dd>
|
|
3532
3586
|
|
|
3533
3587
|
```typescript
|
|
3534
|
-
await client.
|
|
3588
|
+
await client.paymentRequests.decline({
|
|
3589
|
+
idempotencyKey: "Idempotency-Key",
|
|
3590
|
+
paymentRequestId: "paymentRequestId"
|
|
3591
|
+
});
|
|
3535
3592
|
|
|
3536
3593
|
```
|
|
3537
3594
|
</dd>
|
|
@@ -3547,7 +3604,15 @@ await client.parties.getLimits();
|
|
|
3547
3604
|
<dl>
|
|
3548
3605
|
<dd>
|
|
3549
3606
|
|
|
3550
|
-
**
|
|
3607
|
+
**request:** `Natural.DeclinePaymentRequestsRequest`
|
|
3608
|
+
|
|
3609
|
+
</dd>
|
|
3610
|
+
</dl>
|
|
3611
|
+
|
|
3612
|
+
<dl>
|
|
3613
|
+
<dd>
|
|
3614
|
+
|
|
3615
|
+
**requestOptions:** `PaymentRequestsClient.RequestOptions`
|
|
3551
3616
|
|
|
3552
3617
|
</dd>
|
|
3553
3618
|
</dl>
|
|
@@ -3559,7 +3624,7 @@ await client.parties.getLimits();
|
|
|
3559
3624
|
</dl>
|
|
3560
3625
|
</details>
|
|
3561
3626
|
|
|
3562
|
-
<details><summary><code>client.
|
|
3627
|
+
<details><summary><code>client.paymentRequests.<a href="/src/api/resources/paymentRequests/client/Client.ts">cancel</a>({ ...params }) -> Natural.CancelPaymentRequestsResponse</code></summary>
|
|
3563
3628
|
<dl>
|
|
3564
3629
|
<dd>
|
|
3565
3630
|
|
|
@@ -3571,7 +3636,7 @@ await client.parties.getLimits();
|
|
|
3571
3636
|
<dl>
|
|
3572
3637
|
<dd>
|
|
3573
3638
|
|
|
3574
|
-
|
|
3639
|
+
Cancel an open outgoing payment request
|
|
3575
3640
|
</dd>
|
|
3576
3641
|
</dl>
|
|
3577
3642
|
</dd>
|
|
@@ -3586,10 +3651,9 @@ Set the party's approval limits
|
|
|
3586
3651
|
<dd>
|
|
3587
3652
|
|
|
3588
3653
|
```typescript
|
|
3589
|
-
await client.
|
|
3590
|
-
|
|
3591
|
-
|
|
3592
|
-
currency: "USD"
|
|
3654
|
+
await client.paymentRequests.cancel({
|
|
3655
|
+
idempotencyKey: "Idempotency-Key",
|
|
3656
|
+
paymentRequestId: "paymentRequestId"
|
|
3593
3657
|
});
|
|
3594
3658
|
|
|
3595
3659
|
```
|
|
@@ -3606,7 +3670,7 @@ await client.parties.setLimits({
|
|
|
3606
3670
|
<dl>
|
|
3607
3671
|
<dd>
|
|
3608
3672
|
|
|
3609
|
-
**request:** `Natural.
|
|
3673
|
+
**request:** `Natural.CancelPaymentRequestsRequest`
|
|
3610
3674
|
|
|
3611
3675
|
</dd>
|
|
3612
3676
|
</dl>
|
|
@@ -3614,7 +3678,7 @@ await client.parties.setLimits({
|
|
|
3614
3678
|
<dl>
|
|
3615
3679
|
<dd>
|
|
3616
3680
|
|
|
3617
|
-
**requestOptions:** `
|
|
3681
|
+
**requestOptions:** `PaymentRequestsClient.RequestOptions`
|
|
3618
3682
|
|
|
3619
3683
|
</dd>
|
|
3620
3684
|
</dl>
|
|
@@ -3626,7 +3690,8 @@ await client.parties.setLimits({
|
|
|
3626
3690
|
</dl>
|
|
3627
3691
|
</details>
|
|
3628
3692
|
|
|
3629
|
-
|
|
3693
|
+
## Approvals
|
|
3694
|
+
<details><summary><code>client.approvals.<a href="/src/api/resources/approvals/client/Client.ts">list</a>({ ...params }) -> Natural.Approval</code></summary>
|
|
3630
3695
|
<dl>
|
|
3631
3696
|
<dd>
|
|
3632
3697
|
|
|
@@ -3638,7 +3703,7 @@ await client.parties.setLimits({
|
|
|
3638
3703
|
<dl>
|
|
3639
3704
|
<dd>
|
|
3640
3705
|
|
|
3641
|
-
|
|
3706
|
+
List approvals
|
|
3642
3707
|
</dd>
|
|
3643
3708
|
</dl>
|
|
3644
3709
|
</dd>
|
|
@@ -3653,7 +3718,7 @@ Disable all approval limits for the party
|
|
|
3653
3718
|
<dd>
|
|
3654
3719
|
|
|
3655
3720
|
```typescript
|
|
3656
|
-
await client.
|
|
3721
|
+
await client.approvals.list();
|
|
3657
3722
|
|
|
3658
3723
|
```
|
|
3659
3724
|
</dd>
|
|
@@ -3669,7 +3734,15 @@ await client.parties.disableLimits();
|
|
|
3669
3734
|
<dl>
|
|
3670
3735
|
<dd>
|
|
3671
3736
|
|
|
3672
|
-
**
|
|
3737
|
+
**request:** `Natural.ListApprovalsRequest`
|
|
3738
|
+
|
|
3739
|
+
</dd>
|
|
3740
|
+
</dl>
|
|
3741
|
+
|
|
3742
|
+
<dl>
|
|
3743
|
+
<dd>
|
|
3744
|
+
|
|
3745
|
+
**requestOptions:** `ApprovalsClient.RequestOptions`
|
|
3673
3746
|
|
|
3674
3747
|
</dd>
|
|
3675
3748
|
</dl>
|
|
@@ -3681,7 +3754,7 @@ await client.parties.disableLimits();
|
|
|
3681
3754
|
</dl>
|
|
3682
3755
|
</details>
|
|
3683
3756
|
|
|
3684
|
-
<details><summary><code>client.
|
|
3757
|
+
<details><summary><code>client.approvals.<a href="/src/api/resources/approvals/client/Client.ts">get</a>({ ...params }) -> Natural.ApprovalDetail</code></summary>
|
|
3685
3758
|
<dl>
|
|
3686
3759
|
<dd>
|
|
3687
3760
|
|
|
@@ -3693,7 +3766,7 @@ await client.parties.disableLimits();
|
|
|
3693
3766
|
<dl>
|
|
3694
3767
|
<dd>
|
|
3695
3768
|
|
|
3696
|
-
|
|
3769
|
+
Get an approval
|
|
3697
3770
|
</dd>
|
|
3698
3771
|
</dl>
|
|
3699
3772
|
</dd>
|
|
@@ -3708,9 +3781,8 @@ Remove a member from the party
|
|
|
3708
3781
|
<dd>
|
|
3709
3782
|
|
|
3710
3783
|
```typescript
|
|
3711
|
-
await client.
|
|
3712
|
-
|
|
3713
|
-
userId: "userId"
|
|
3784
|
+
await client.approvals.get({
|
|
3785
|
+
approvalId: "approvalId"
|
|
3714
3786
|
});
|
|
3715
3787
|
|
|
3716
3788
|
```
|
|
@@ -3727,7 +3799,7 @@ await client.parties.removeMember({
|
|
|
3727
3799
|
<dl>
|
|
3728
3800
|
<dd>
|
|
3729
3801
|
|
|
3730
|
-
**request:** `Natural.
|
|
3802
|
+
**request:** `Natural.GetApprovalsRequest`
|
|
3731
3803
|
|
|
3732
3804
|
</dd>
|
|
3733
3805
|
</dl>
|
|
@@ -3735,7 +3807,7 @@ await client.parties.removeMember({
|
|
|
3735
3807
|
<dl>
|
|
3736
3808
|
<dd>
|
|
3737
3809
|
|
|
3738
|
-
**requestOptions:** `
|
|
3810
|
+
**requestOptions:** `ApprovalsClient.RequestOptions`
|
|
3739
3811
|
|
|
3740
3812
|
</dd>
|
|
3741
3813
|
</dl>
|
|
@@ -3747,8 +3819,7 @@ await client.parties.removeMember({
|
|
|
3747
3819
|
</dl>
|
|
3748
3820
|
</details>
|
|
3749
3821
|
|
|
3750
|
-
|
|
3751
|
-
<details><summary><code>client.wallets.<a href="/src/api/resources/wallets/client/Client.ts">list</a>({ ...params }) -> Natural.Wallet</code></summary>
|
|
3822
|
+
<details><summary><code>client.approvals.<a href="/src/api/resources/approvals/client/Client.ts">approve</a>({ ...params }) -> Natural.ApproveResult</code></summary>
|
|
3752
3823
|
<dl>
|
|
3753
3824
|
<dd>
|
|
3754
3825
|
|
|
@@ -3760,7 +3831,7 @@ await client.parties.removeMember({
|
|
|
3760
3831
|
<dl>
|
|
3761
3832
|
<dd>
|
|
3762
3833
|
|
|
3763
|
-
|
|
3834
|
+
Approve the payment or transfer under review
|
|
3764
3835
|
</dd>
|
|
3765
3836
|
</dl>
|
|
3766
3837
|
</dd>
|
|
@@ -3775,7 +3846,10 @@ List wallets
|
|
|
3775
3846
|
<dd>
|
|
3776
3847
|
|
|
3777
3848
|
```typescript
|
|
3778
|
-
await client.
|
|
3849
|
+
await client.approvals.approve({
|
|
3850
|
+
idempotencyKey: "Idempotency-Key",
|
|
3851
|
+
approvalId: "approvalId"
|
|
3852
|
+
});
|
|
3779
3853
|
|
|
3780
3854
|
```
|
|
3781
3855
|
</dd>
|
|
@@ -3791,7 +3865,7 @@ await client.wallets.list();
|
|
|
3791
3865
|
<dl>
|
|
3792
3866
|
<dd>
|
|
3793
3867
|
|
|
3794
|
-
**request:** `Natural.
|
|
3868
|
+
**request:** `Natural.ApproveApprovalsRequest`
|
|
3795
3869
|
|
|
3796
3870
|
</dd>
|
|
3797
3871
|
</dl>
|
|
@@ -3799,7 +3873,7 @@ await client.wallets.list();
|
|
|
3799
3873
|
<dl>
|
|
3800
3874
|
<dd>
|
|
3801
3875
|
|
|
3802
|
-
**requestOptions:** `
|
|
3876
|
+
**requestOptions:** `ApprovalsClient.RequestOptions`
|
|
3803
3877
|
|
|
3804
3878
|
</dd>
|
|
3805
3879
|
</dl>
|
|
@@ -3811,7 +3885,7 @@ await client.wallets.list();
|
|
|
3811
3885
|
</dl>
|
|
3812
3886
|
</details>
|
|
3813
3887
|
|
|
3814
|
-
<details><summary><code>client.
|
|
3888
|
+
<details><summary><code>client.approvals.<a href="/src/api/resources/approvals/client/Client.ts">deny</a>({ ...params }) -> Natural.DenyResult</code></summary>
|
|
3815
3889
|
<dl>
|
|
3816
3890
|
<dd>
|
|
3817
3891
|
|
|
@@ -3823,7 +3897,7 @@ await client.wallets.list();
|
|
|
3823
3897
|
<dl>
|
|
3824
3898
|
<dd>
|
|
3825
3899
|
|
|
3826
|
-
|
|
3900
|
+
Deny the payment or transfer under review
|
|
3827
3901
|
</dd>
|
|
3828
3902
|
</dl>
|
|
3829
3903
|
</dd>
|
|
@@ -3837,14 +3911,11 @@ Create a standard wallet
|
|
|
3837
3911
|
<dl>
|
|
3838
3912
|
<dd>
|
|
3839
3913
|
|
|
3840
|
-
```typescript
|
|
3841
|
-
await client.
|
|
3842
|
-
idempotencyKey: "Idempotency-Key",
|
|
3843
|
-
|
|
3844
|
-
|
|
3845
|
-
tags: {
|
|
3846
|
-
"department": "payroll"
|
|
3847
|
-
}
|
|
3914
|
+
```typescript
|
|
3915
|
+
await client.approvals.deny({
|
|
3916
|
+
idempotencyKey: "Idempotency-Key",
|
|
3917
|
+
approvalId: "approvalId",
|
|
3918
|
+
reason: "Invoice does not match the vendor's bank account on file"
|
|
3848
3919
|
});
|
|
3849
3920
|
|
|
3850
3921
|
```
|
|
@@ -3861,7 +3932,7 @@ await client.wallets.create({
|
|
|
3861
3932
|
<dl>
|
|
3862
3933
|
<dd>
|
|
3863
3934
|
|
|
3864
|
-
**request:** `Natural.
|
|
3935
|
+
**request:** `Natural.DenyApprovalsRequest`
|
|
3865
3936
|
|
|
3866
3937
|
</dd>
|
|
3867
3938
|
</dl>
|
|
@@ -3869,7 +3940,7 @@ await client.wallets.create({
|
|
|
3869
3940
|
<dl>
|
|
3870
3941
|
<dd>
|
|
3871
3942
|
|
|
3872
|
-
**requestOptions:** `
|
|
3943
|
+
**requestOptions:** `ApprovalsClient.RequestOptions`
|
|
3873
3944
|
|
|
3874
3945
|
</dd>
|
|
3875
3946
|
</dl>
|
|
@@ -3881,7 +3952,8 @@ await client.wallets.create({
|
|
|
3881
3952
|
</dl>
|
|
3882
3953
|
</details>
|
|
3883
3954
|
|
|
3884
|
-
|
|
3955
|
+
## Invitations
|
|
3956
|
+
<details><summary><code>client.invitations.<a href="/src/api/resources/invitations/client/Client.ts">list</a>({ ...params }) -> Natural.ListInvitationsResponse</code></summary>
|
|
3885
3957
|
<dl>
|
|
3886
3958
|
<dd>
|
|
3887
3959
|
|
|
@@ -3893,7 +3965,7 @@ await client.wallets.create({
|
|
|
3893
3965
|
<dl>
|
|
3894
3966
|
<dd>
|
|
3895
3967
|
|
|
3896
|
-
|
|
3968
|
+
List party invitations
|
|
3897
3969
|
</dd>
|
|
3898
3970
|
</dl>
|
|
3899
3971
|
</dd>
|
|
@@ -3908,9 +3980,7 @@ Get a wallet
|
|
|
3908
3980
|
<dd>
|
|
3909
3981
|
|
|
3910
3982
|
```typescript
|
|
3911
|
-
await client.
|
|
3912
|
-
walletId: "walletId"
|
|
3913
|
-
});
|
|
3983
|
+
await client.invitations.list();
|
|
3914
3984
|
|
|
3915
3985
|
```
|
|
3916
3986
|
</dd>
|
|
@@ -3926,7 +3996,7 @@ await client.wallets.get({
|
|
|
3926
3996
|
<dl>
|
|
3927
3997
|
<dd>
|
|
3928
3998
|
|
|
3929
|
-
**request:** `Natural.
|
|
3999
|
+
**request:** `Natural.ListInvitationsRequest`
|
|
3930
4000
|
|
|
3931
4001
|
</dd>
|
|
3932
4002
|
</dl>
|
|
@@ -3934,7 +4004,7 @@ await client.wallets.get({
|
|
|
3934
4004
|
<dl>
|
|
3935
4005
|
<dd>
|
|
3936
4006
|
|
|
3937
|
-
**requestOptions:** `
|
|
4007
|
+
**requestOptions:** `InvitationsClient.RequestOptions`
|
|
3938
4008
|
|
|
3939
4009
|
</dd>
|
|
3940
4010
|
</dl>
|
|
@@ -3946,7 +4016,7 @@ await client.wallets.get({
|
|
|
3946
4016
|
</dl>
|
|
3947
4017
|
</details>
|
|
3948
4018
|
|
|
3949
|
-
<details><summary><code>client.
|
|
4019
|
+
<details><summary><code>client.invitations.<a href="/src/api/resources/invitations/client/Client.ts">create</a>({ ...params }) -> Natural.CreateInvitationsResponse</code></summary>
|
|
3950
4020
|
<dl>
|
|
3951
4021
|
<dd>
|
|
3952
4022
|
|
|
@@ -3958,7 +4028,7 @@ await client.wallets.get({
|
|
|
3958
4028
|
<dl>
|
|
3959
4029
|
<dd>
|
|
3960
4030
|
|
|
3961
|
-
|
|
4031
|
+
Invite people to join the party. Available for business parties.
|
|
3962
4032
|
</dd>
|
|
3963
4033
|
</dl>
|
|
3964
4034
|
</dd>
|
|
@@ -3973,14 +4043,16 @@ Update a wallet's display name, description, or tags
|
|
|
3973
4043
|
<dd>
|
|
3974
4044
|
|
|
3975
4045
|
```typescript
|
|
3976
|
-
await client.
|
|
3977
|
-
|
|
3978
|
-
|
|
3979
|
-
|
|
3980
|
-
|
|
4046
|
+
await client.invitations.create({
|
|
4047
|
+
invitations: [{
|
|
4048
|
+
email: "engineer@velocitylogistics.com",
|
|
4049
|
+
role: "MEMBER"
|
|
4050
|
+
}, {
|
|
4051
|
+
email: "cfo@velocitylogistics.com",
|
|
4052
|
+
role: "ADMIN"
|
|
4053
|
+
}],
|
|
3981
4054
|
tags: {
|
|
3982
|
-
"
|
|
3983
|
-
"legacy_key": null
|
|
4055
|
+
"team": "operations"
|
|
3984
4056
|
}
|
|
3985
4057
|
});
|
|
3986
4058
|
|
|
@@ -3998,7 +4070,7 @@ await client.wallets.update({
|
|
|
3998
4070
|
<dl>
|
|
3999
4071
|
<dd>
|
|
4000
4072
|
|
|
4001
|
-
**request:** `Natural.
|
|
4073
|
+
**request:** `Natural.CreateInvitationsRequest`
|
|
4002
4074
|
|
|
4003
4075
|
</dd>
|
|
4004
4076
|
</dl>
|
|
@@ -4006,7 +4078,7 @@ await client.wallets.update({
|
|
|
4006
4078
|
<dl>
|
|
4007
4079
|
<dd>
|
|
4008
4080
|
|
|
4009
|
-
**requestOptions:** `
|
|
4081
|
+
**requestOptions:** `InvitationsClient.RequestOptions`
|
|
4010
4082
|
|
|
4011
4083
|
</dd>
|
|
4012
4084
|
</dl>
|
|
@@ -4018,7 +4090,7 @@ await client.wallets.update({
|
|
|
4018
4090
|
</dl>
|
|
4019
4091
|
</details>
|
|
4020
4092
|
|
|
4021
|
-
<details><summary><code>client.
|
|
4093
|
+
<details><summary><code>client.invitations.<a href="/src/api/resources/invitations/client/Client.ts">revoke</a>({ ...params }) -> Natural.RevokeInvitationsResponse</code></summary>
|
|
4022
4094
|
<dl>
|
|
4023
4095
|
<dd>
|
|
4024
4096
|
|
|
@@ -4030,7 +4102,7 @@ await client.wallets.update({
|
|
|
4030
4102
|
<dl>
|
|
4031
4103
|
<dd>
|
|
4032
4104
|
|
|
4033
|
-
|
|
4105
|
+
Revoke a pending party invitation
|
|
4034
4106
|
</dd>
|
|
4035
4107
|
</dl>
|
|
4036
4108
|
</dd>
|
|
@@ -4045,9 +4117,9 @@ Set the party's default wallet, where payments addressed to their email, phone n
|
|
|
4045
4117
|
<dd>
|
|
4046
4118
|
|
|
4047
4119
|
```typescript
|
|
4048
|
-
await client.
|
|
4120
|
+
await client.invitations.revoke({
|
|
4049
4121
|
idempotencyKey: "Idempotency-Key",
|
|
4050
|
-
|
|
4122
|
+
invitationId: "invitationId"
|
|
4051
4123
|
});
|
|
4052
4124
|
|
|
4053
4125
|
```
|
|
@@ -4064,7 +4136,7 @@ await client.wallets.setDefault({
|
|
|
4064
4136
|
<dl>
|
|
4065
4137
|
<dd>
|
|
4066
4138
|
|
|
4067
|
-
**request:** `Natural.
|
|
4139
|
+
**request:** `Natural.RevokeInvitationsRequest`
|
|
4068
4140
|
|
|
4069
4141
|
</dd>
|
|
4070
4142
|
</dl>
|
|
@@ -4072,7 +4144,7 @@ await client.wallets.setDefault({
|
|
|
4072
4144
|
<dl>
|
|
4073
4145
|
<dd>
|
|
4074
4146
|
|
|
4075
|
-
**requestOptions:** `
|
|
4147
|
+
**requestOptions:** `InvitationsClient.RequestOptions`
|
|
4076
4148
|
|
|
4077
4149
|
</dd>
|
|
4078
4150
|
</dl>
|
|
@@ -4084,7 +4156,8 @@ await client.wallets.setDefault({
|
|
|
4084
4156
|
</dl>
|
|
4085
4157
|
</details>
|
|
4086
4158
|
|
|
4087
|
-
|
|
4159
|
+
## Parties
|
|
4160
|
+
<details><summary><code>client.parties.<a href="/src/api/resources/parties/client/Client.ts">get</a>() -> Natural.MyPartyDetail</code></summary>
|
|
4088
4161
|
<dl>
|
|
4089
4162
|
<dd>
|
|
4090
4163
|
|
|
@@ -4096,7 +4169,7 @@ await client.wallets.setDefault({
|
|
|
4096
4169
|
<dl>
|
|
4097
4170
|
<dd>
|
|
4098
4171
|
|
|
4099
|
-
|
|
4172
|
+
Get the current party
|
|
4100
4173
|
</dd>
|
|
4101
4174
|
</dl>
|
|
4102
4175
|
</dd>
|
|
@@ -4111,9 +4184,7 @@ Freeze a wallet
|
|
|
4111
4184
|
<dd>
|
|
4112
4185
|
|
|
4113
4186
|
```typescript
|
|
4114
|
-
await client.
|
|
4115
|
-
walletId: "walletId"
|
|
4116
|
-
});
|
|
4187
|
+
await client.parties.get();
|
|
4117
4188
|
|
|
4118
4189
|
```
|
|
4119
4190
|
</dd>
|
|
@@ -4129,15 +4200,7 @@ await client.wallets.freeze({
|
|
|
4129
4200
|
<dl>
|
|
4130
4201
|
<dd>
|
|
4131
4202
|
|
|
4132
|
-
**
|
|
4133
|
-
|
|
4134
|
-
</dd>
|
|
4135
|
-
</dl>
|
|
4136
|
-
|
|
4137
|
-
<dl>
|
|
4138
|
-
<dd>
|
|
4139
|
-
|
|
4140
|
-
**requestOptions:** `WalletsClient.RequestOptions`
|
|
4203
|
+
**requestOptions:** `PartiesClient.RequestOptions`
|
|
4141
4204
|
|
|
4142
4205
|
</dd>
|
|
4143
4206
|
</dl>
|
|
@@ -4149,7 +4212,7 @@ await client.wallets.freeze({
|
|
|
4149
4212
|
</dl>
|
|
4150
4213
|
</details>
|
|
4151
4214
|
|
|
4152
|
-
<details><summary><code>client.
|
|
4215
|
+
<details><summary><code>client.parties.<a href="/src/api/resources/parties/client/Client.ts">update</a>({ ...params }) -> Natural.UpdMyParty</code></summary>
|
|
4153
4216
|
<dl>
|
|
4154
4217
|
<dd>
|
|
4155
4218
|
|
|
@@ -4161,7 +4224,7 @@ await client.wallets.freeze({
|
|
|
4161
4224
|
<dl>
|
|
4162
4225
|
<dd>
|
|
4163
4226
|
|
|
4164
|
-
|
|
4227
|
+
Update the current party
|
|
4165
4228
|
</dd>
|
|
4166
4229
|
</dl>
|
|
4167
4230
|
</dd>
|
|
@@ -4176,8 +4239,8 @@ Unfreeze a wallet that was frozen through the API
|
|
|
4176
4239
|
<dd>
|
|
4177
4240
|
|
|
4178
4241
|
```typescript
|
|
4179
|
-
await client.
|
|
4180
|
-
|
|
4242
|
+
await client.parties.update({
|
|
4243
|
+
displayName: "Natural Inc."
|
|
4181
4244
|
});
|
|
4182
4245
|
|
|
4183
4246
|
```
|
|
@@ -4194,7 +4257,7 @@ await client.wallets.unfreeze({
|
|
|
4194
4257
|
<dl>
|
|
4195
4258
|
<dd>
|
|
4196
4259
|
|
|
4197
|
-
**request:** `Natural.
|
|
4260
|
+
**request:** `Natural.UpdMyPartyParams`
|
|
4198
4261
|
|
|
4199
4262
|
</dd>
|
|
4200
4263
|
</dl>
|
|
@@ -4202,7 +4265,7 @@ await client.wallets.unfreeze({
|
|
|
4202
4265
|
<dl>
|
|
4203
4266
|
<dd>
|
|
4204
4267
|
|
|
4205
|
-
**requestOptions:** `
|
|
4268
|
+
**requestOptions:** `PartiesClient.RequestOptions`
|
|
4206
4269
|
|
|
4207
4270
|
</dd>
|
|
4208
4271
|
</dl>
|
|
@@ -4214,7 +4277,7 @@ await client.wallets.unfreeze({
|
|
|
4214
4277
|
</dl>
|
|
4215
4278
|
</details>
|
|
4216
4279
|
|
|
4217
|
-
<details><summary><code>client.
|
|
4280
|
+
<details><summary><code>client.parties.<a href="/src/api/resources/parties/client/Client.ts">listMembers</a>({ ...params }) -> core.Page<Natural.ListMembersPartiesResponseDataItem, Natural.ListMembersPartiesResponse></code></summary>
|
|
4218
4281
|
<dl>
|
|
4219
4282
|
<dd>
|
|
4220
4283
|
|
|
@@ -4226,7 +4289,7 @@ await client.wallets.unfreeze({
|
|
|
4226
4289
|
<dl>
|
|
4227
4290
|
<dd>
|
|
4228
4291
|
|
|
4229
|
-
List
|
|
4292
|
+
List active members of the party. Available for business parties.
|
|
4230
4293
|
</dd>
|
|
4231
4294
|
</dl>
|
|
4232
4295
|
</dd>
|
|
@@ -4241,9 +4304,19 @@ List agents granted access to a wallet
|
|
|
4241
4304
|
<dd>
|
|
4242
4305
|
|
|
4243
4306
|
```typescript
|
|
4244
|
-
await client.
|
|
4245
|
-
|
|
4246
|
-
|
|
4307
|
+
const pageableResponse = await client.parties.listMembers();
|
|
4308
|
+
for await (const item of pageableResponse) {
|
|
4309
|
+
console.log(item);
|
|
4310
|
+
}
|
|
4311
|
+
|
|
4312
|
+
// Or you can manually iterate page-by-page
|
|
4313
|
+
let page = await client.parties.listMembers();
|
|
4314
|
+
while (page.hasNextPage()) {
|
|
4315
|
+
page = page.getNextPage();
|
|
4316
|
+
}
|
|
4317
|
+
|
|
4318
|
+
// You can also access the underlying response
|
|
4319
|
+
const response = page.response;
|
|
4247
4320
|
|
|
4248
4321
|
```
|
|
4249
4322
|
</dd>
|
|
@@ -4259,7 +4332,7 @@ await client.wallets.listAgents({
|
|
|
4259
4332
|
<dl>
|
|
4260
4333
|
<dd>
|
|
4261
4334
|
|
|
4262
|
-
**request:** `Natural.
|
|
4335
|
+
**request:** `Natural.ListMembersPartiesRequest`
|
|
4263
4336
|
|
|
4264
4337
|
</dd>
|
|
4265
4338
|
</dl>
|
|
@@ -4267,7 +4340,7 @@ await client.wallets.listAgents({
|
|
|
4267
4340
|
<dl>
|
|
4268
4341
|
<dd>
|
|
4269
4342
|
|
|
4270
|
-
**requestOptions:** `
|
|
4343
|
+
**requestOptions:** `PartiesClient.RequestOptions`
|
|
4271
4344
|
|
|
4272
4345
|
</dd>
|
|
4273
4346
|
</dl>
|
|
@@ -4279,7 +4352,7 @@ await client.wallets.listAgents({
|
|
|
4279
4352
|
</dl>
|
|
4280
4353
|
</details>
|
|
4281
4354
|
|
|
4282
|
-
<details><summary><code>client.
|
|
4355
|
+
<details><summary><code>client.parties.<a href="/src/api/resources/parties/client/Client.ts">getCompliance</a>({ ...params }) -> Natural.GetCompliancePartiesResponse</code></summary>
|
|
4283
4356
|
<dl>
|
|
4284
4357
|
<dd>
|
|
4285
4358
|
|
|
@@ -4291,7 +4364,7 @@ await client.wallets.listAgents({
|
|
|
4291
4364
|
<dl>
|
|
4292
4365
|
<dd>
|
|
4293
4366
|
|
|
4294
|
-
|
|
4367
|
+
Get a party's current compliance status
|
|
4295
4368
|
</dd>
|
|
4296
4369
|
</dl>
|
|
4297
4370
|
</dd>
|
|
@@ -4306,10 +4379,8 @@ Grant an agent access to a wallet
|
|
|
4306
4379
|
<dd>
|
|
4307
4380
|
|
|
4308
4381
|
```typescript
|
|
4309
|
-
await client.
|
|
4310
|
-
|
|
4311
|
-
walletId: "walletId",
|
|
4312
|
-
agentId: "agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f"
|
|
4382
|
+
await client.parties.getCompliance({
|
|
4383
|
+
partyId: "partyId"
|
|
4313
4384
|
});
|
|
4314
4385
|
|
|
4315
4386
|
```
|
|
@@ -4326,7 +4397,7 @@ await client.wallets.attachAgent({
|
|
|
4326
4397
|
<dl>
|
|
4327
4398
|
<dd>
|
|
4328
4399
|
|
|
4329
|
-
**request:** `Natural.
|
|
4400
|
+
**request:** `Natural.GetCompliancePartiesRequest`
|
|
4330
4401
|
|
|
4331
4402
|
</dd>
|
|
4332
4403
|
</dl>
|
|
@@ -4334,7 +4405,7 @@ await client.wallets.attachAgent({
|
|
|
4334
4405
|
<dl>
|
|
4335
4406
|
<dd>
|
|
4336
4407
|
|
|
4337
|
-
**requestOptions:** `
|
|
4408
|
+
**requestOptions:** `PartiesClient.RequestOptions`
|
|
4338
4409
|
|
|
4339
4410
|
</dd>
|
|
4340
4411
|
</dl>
|
|
@@ -4346,7 +4417,7 @@ await client.wallets.attachAgent({
|
|
|
4346
4417
|
</dl>
|
|
4347
4418
|
</details>
|
|
4348
4419
|
|
|
4349
|
-
<details><summary><code>client.
|
|
4420
|
+
<details><summary><code>client.parties.<a href="/src/api/resources/parties/client/Client.ts">setHandle</a>({ ...params }) -> Natural.SetHandlePartiesResponse</code></summary>
|
|
4350
4421
|
<dl>
|
|
4351
4422
|
<dd>
|
|
4352
4423
|
|
|
@@ -4358,7 +4429,7 @@ await client.wallets.attachAgent({
|
|
|
4358
4429
|
<dl>
|
|
4359
4430
|
<dd>
|
|
4360
4431
|
|
|
4361
|
-
|
|
4432
|
+
Set or rename your party's handle; it can never be cleared
|
|
4362
4433
|
</dd>
|
|
4363
4434
|
</dl>
|
|
4364
4435
|
</dd>
|
|
@@ -4373,10 +4444,8 @@ Make this wallet the default for the attached agent
|
|
|
4373
4444
|
<dd>
|
|
4374
4445
|
|
|
4375
4446
|
```typescript
|
|
4376
|
-
await client.
|
|
4377
|
-
|
|
4378
|
-
walletId: "walletId",
|
|
4379
|
-
agentId: "agentId"
|
|
4447
|
+
await client.parties.setHandle({
|
|
4448
|
+
handle: "natural"
|
|
4380
4449
|
});
|
|
4381
4450
|
|
|
4382
4451
|
```
|
|
@@ -4393,7 +4462,7 @@ await client.wallets.setAgentDefaultWallet({
|
|
|
4393
4462
|
<dl>
|
|
4394
4463
|
<dd>
|
|
4395
4464
|
|
|
4396
|
-
**request:** `Natural.
|
|
4465
|
+
**request:** `Natural.SetHandlePartiesRequest`
|
|
4397
4466
|
|
|
4398
4467
|
</dd>
|
|
4399
4468
|
</dl>
|
|
@@ -4401,7 +4470,7 @@ await client.wallets.setAgentDefaultWallet({
|
|
|
4401
4470
|
<dl>
|
|
4402
4471
|
<dd>
|
|
4403
4472
|
|
|
4404
|
-
**requestOptions:** `
|
|
4473
|
+
**requestOptions:** `PartiesClient.RequestOptions`
|
|
4405
4474
|
|
|
4406
4475
|
</dd>
|
|
4407
4476
|
</dl>
|
|
@@ -4413,7 +4482,7 @@ await client.wallets.setAgentDefaultWallet({
|
|
|
4413
4482
|
</dl>
|
|
4414
4483
|
</details>
|
|
4415
4484
|
|
|
4416
|
-
<details><summary><code>client.
|
|
4485
|
+
<details><summary><code>client.parties.<a href="/src/api/resources/parties/client/Client.ts">getLimits</a>() -> Natural.GetLimitsPartiesResponse</code></summary>
|
|
4417
4486
|
<dl>
|
|
4418
4487
|
<dd>
|
|
4419
4488
|
|
|
@@ -4425,7 +4494,7 @@ await client.wallets.setAgentDefaultWallet({
|
|
|
4425
4494
|
<dl>
|
|
4426
4495
|
<dd>
|
|
4427
4496
|
|
|
4428
|
-
|
|
4497
|
+
Get the party's approval limits
|
|
4429
4498
|
</dd>
|
|
4430
4499
|
</dl>
|
|
4431
4500
|
</dd>
|
|
@@ -4440,11 +4509,7 @@ Detach an agent from a wallet
|
|
|
4440
4509
|
<dd>
|
|
4441
4510
|
|
|
4442
4511
|
```typescript
|
|
4443
|
-
await client.
|
|
4444
|
-
idempotencyKey: "Idempotency-Key",
|
|
4445
|
-
walletId: "walletId",
|
|
4446
|
-
agentId: "agentId"
|
|
4447
|
-
});
|
|
4512
|
+
await client.parties.getLimits();
|
|
4448
4513
|
|
|
4449
4514
|
```
|
|
4450
4515
|
</dd>
|
|
@@ -4460,15 +4525,7 @@ await client.wallets.detachAgent({
|
|
|
4460
4525
|
<dl>
|
|
4461
4526
|
<dd>
|
|
4462
4527
|
|
|
4463
|
-
**
|
|
4464
|
-
|
|
4465
|
-
</dd>
|
|
4466
|
-
</dl>
|
|
4467
|
-
|
|
4468
|
-
<dl>
|
|
4469
|
-
<dd>
|
|
4470
|
-
|
|
4471
|
-
**requestOptions:** `WalletsClient.RequestOptions`
|
|
4528
|
+
**requestOptions:** `PartiesClient.RequestOptions`
|
|
4472
4529
|
|
|
4473
4530
|
</dd>
|
|
4474
4531
|
</dl>
|
|
@@ -4480,8 +4537,7 @@ await client.wallets.detachAgent({
|
|
|
4480
4537
|
</dl>
|
|
4481
4538
|
</details>
|
|
4482
4539
|
|
|
4483
|
-
|
|
4484
|
-
<details><summary><code>client.externalAccounts.<a href="/src/api/resources/externalAccounts/client/Client.ts">createFromProcessorToken</a>({ ...params }) -> Natural.CreateFromProcessorTokenExternalAccountsResponse</code></summary>
|
|
4540
|
+
<details><summary><code>client.parties.<a href="/src/api/resources/parties/client/Client.ts">setLimits</a>({ ...params }) -> Natural.SetLimitsPartiesResponse</code></summary>
|
|
4485
4541
|
<dl>
|
|
4486
4542
|
<dd>
|
|
4487
4543
|
|
|
@@ -4493,7 +4549,7 @@ await client.wallets.detachAgent({
|
|
|
4493
4549
|
<dl>
|
|
4494
4550
|
<dd>
|
|
4495
4551
|
|
|
4496
|
-
|
|
4552
|
+
Set the party's approval limits
|
|
4497
4553
|
</dd>
|
|
4498
4554
|
</dl>
|
|
4499
4555
|
</dd>
|
|
@@ -4508,14 +4564,10 @@ Link or refresh a bank account using a Plaid processor token
|
|
|
4508
4564
|
<dd>
|
|
4509
4565
|
|
|
4510
4566
|
```typescript
|
|
4511
|
-
await client.
|
|
4512
|
-
|
|
4513
|
-
|
|
4514
|
-
|
|
4515
|
-
institutionName: "Plaid Sandbox",
|
|
4516
|
-
tags: {
|
|
4517
|
-
"environment": "sandbox"
|
|
4518
|
-
}
|
|
4567
|
+
await client.parties.setLimits({
|
|
4568
|
+
perTransaction: 250000,
|
|
4569
|
+
perDay: 1000000,
|
|
4570
|
+
currency: "USD"
|
|
4519
4571
|
});
|
|
4520
4572
|
|
|
4521
4573
|
```
|
|
@@ -4532,7 +4584,7 @@ await client.externalAccounts.createFromProcessorToken({
|
|
|
4532
4584
|
<dl>
|
|
4533
4585
|
<dd>
|
|
4534
4586
|
|
|
4535
|
-
**request:** `Natural.
|
|
4587
|
+
**request:** `Natural.SetLimitsPartiesRequest`
|
|
4536
4588
|
|
|
4537
4589
|
</dd>
|
|
4538
4590
|
</dl>
|
|
@@ -4540,7 +4592,7 @@ await client.externalAccounts.createFromProcessorToken({
|
|
|
4540
4592
|
<dl>
|
|
4541
4593
|
<dd>
|
|
4542
4594
|
|
|
4543
|
-
**requestOptions:** `
|
|
4595
|
+
**requestOptions:** `PartiesClient.RequestOptions`
|
|
4544
4596
|
|
|
4545
4597
|
</dd>
|
|
4546
4598
|
</dl>
|
|
@@ -4552,7 +4604,7 @@ await client.externalAccounts.createFromProcessorToken({
|
|
|
4552
4604
|
</dl>
|
|
4553
4605
|
</details>
|
|
4554
4606
|
|
|
4555
|
-
<details><summary><code>client.
|
|
4607
|
+
<details><summary><code>client.parties.<a href="/src/api/resources/parties/client/Client.ts">disableLimits</a>() -> Natural.DisableLimitsPartiesResponse</code></summary>
|
|
4556
4608
|
<dl>
|
|
4557
4609
|
<dd>
|
|
4558
4610
|
|
|
@@ -4564,7 +4616,7 @@ await client.externalAccounts.createFromProcessorToken({
|
|
|
4564
4616
|
<dl>
|
|
4565
4617
|
<dd>
|
|
4566
4618
|
|
|
4567
|
-
|
|
4619
|
+
Disable all approval limits for the party
|
|
4568
4620
|
</dd>
|
|
4569
4621
|
</dl>
|
|
4570
4622
|
</dd>
|
|
@@ -4579,19 +4631,7 @@ List linked external accounts
|
|
|
4579
4631
|
<dd>
|
|
4580
4632
|
|
|
4581
4633
|
```typescript
|
|
4582
|
-
|
|
4583
|
-
for await (const item of pageableResponse) {
|
|
4584
|
-
console.log(item);
|
|
4585
|
-
}
|
|
4586
|
-
|
|
4587
|
-
// Or you can manually iterate page-by-page
|
|
4588
|
-
let page = await client.externalAccounts.list();
|
|
4589
|
-
while (page.hasNextPage()) {
|
|
4590
|
-
page = page.getNextPage();
|
|
4591
|
-
}
|
|
4592
|
-
|
|
4593
|
-
// You can also access the underlying response
|
|
4594
|
-
const response = page.response;
|
|
4634
|
+
await client.parties.disableLimits();
|
|
4595
4635
|
|
|
4596
4636
|
```
|
|
4597
4637
|
</dd>
|
|
@@ -4607,15 +4647,7 @@ const response = page.response;
|
|
|
4607
4647
|
<dl>
|
|
4608
4648
|
<dd>
|
|
4609
4649
|
|
|
4610
|
-
**
|
|
4611
|
-
|
|
4612
|
-
</dd>
|
|
4613
|
-
</dl>
|
|
4614
|
-
|
|
4615
|
-
<dl>
|
|
4616
|
-
<dd>
|
|
4617
|
-
|
|
4618
|
-
**requestOptions:** `ExternalAccountsClient.RequestOptions`
|
|
4650
|
+
**requestOptions:** `PartiesClient.RequestOptions`
|
|
4619
4651
|
|
|
4620
4652
|
</dd>
|
|
4621
4653
|
</dl>
|
|
@@ -4627,7 +4659,7 @@ const response = page.response;
|
|
|
4627
4659
|
</dl>
|
|
4628
4660
|
</details>
|
|
4629
4661
|
|
|
4630
|
-
<details><summary><code>client.
|
|
4662
|
+
<details><summary><code>client.parties.<a href="/src/api/resources/parties/client/Client.ts">removeMember</a>({ ...params }) -> Natural.RemoveMemberPartiesResponse</code></summary>
|
|
4631
4663
|
<dl>
|
|
4632
4664
|
<dd>
|
|
4633
4665
|
|
|
@@ -4639,7 +4671,7 @@ const response = page.response;
|
|
|
4639
4671
|
<dl>
|
|
4640
4672
|
<dd>
|
|
4641
4673
|
|
|
4642
|
-
|
|
4674
|
+
Remove a member from the party
|
|
4643
4675
|
</dd>
|
|
4644
4676
|
</dl>
|
|
4645
4677
|
</dd>
|
|
@@ -4654,8 +4686,9 @@ Get a linked external account
|
|
|
4654
4686
|
<dd>
|
|
4655
4687
|
|
|
4656
4688
|
```typescript
|
|
4657
|
-
await client.
|
|
4658
|
-
|
|
4689
|
+
await client.parties.removeMember({
|
|
4690
|
+
idempotencyKey: "Idempotency-Key",
|
|
4691
|
+
userId: "userId"
|
|
4659
4692
|
});
|
|
4660
4693
|
|
|
4661
4694
|
```
|
|
@@ -4672,7 +4705,7 @@ await client.externalAccounts.get({
|
|
|
4672
4705
|
<dl>
|
|
4673
4706
|
<dd>
|
|
4674
4707
|
|
|
4675
|
-
**request:** `Natural.
|
|
4708
|
+
**request:** `Natural.RemoveMemberPartiesRequest`
|
|
4676
4709
|
|
|
4677
4710
|
</dd>
|
|
4678
4711
|
</dl>
|
|
@@ -4680,7 +4713,7 @@ await client.externalAccounts.get({
|
|
|
4680
4713
|
<dl>
|
|
4681
4714
|
<dd>
|
|
4682
4715
|
|
|
4683
|
-
**requestOptions:** `
|
|
4716
|
+
**requestOptions:** `PartiesClient.RequestOptions`
|
|
4684
4717
|
|
|
4685
4718
|
</dd>
|
|
4686
4719
|
</dl>
|
|
@@ -4692,7 +4725,8 @@ await client.externalAccounts.get({
|
|
|
4692
4725
|
</dl>
|
|
4693
4726
|
</details>
|
|
4694
4727
|
|
|
4695
|
-
|
|
4728
|
+
## Wallets
|
|
4729
|
+
<details><summary><code>client.wallets.<a href="/src/api/resources/wallets/client/Client.ts">list</a>({ ...params }) -> Natural.Wallet</code></summary>
|
|
4696
4730
|
<dl>
|
|
4697
4731
|
<dd>
|
|
4698
4732
|
|
|
@@ -4704,7 +4738,7 @@ await client.externalAccounts.get({
|
|
|
4704
4738
|
<dl>
|
|
4705
4739
|
<dd>
|
|
4706
4740
|
|
|
4707
|
-
|
|
4741
|
+
List wallets
|
|
4708
4742
|
</dd>
|
|
4709
4743
|
</dl>
|
|
4710
4744
|
</dd>
|
|
@@ -4719,9 +4753,7 @@ Remove a linked external account
|
|
|
4719
4753
|
<dd>
|
|
4720
4754
|
|
|
4721
4755
|
```typescript
|
|
4722
|
-
await client.
|
|
4723
|
-
externalAccountId: "externalAccountId"
|
|
4724
|
-
});
|
|
4756
|
+
await client.wallets.list();
|
|
4725
4757
|
|
|
4726
4758
|
```
|
|
4727
4759
|
</dd>
|
|
@@ -4737,7 +4769,7 @@ await client.externalAccounts.remove({
|
|
|
4737
4769
|
<dl>
|
|
4738
4770
|
<dd>
|
|
4739
4771
|
|
|
4740
|
-
**request:** `Natural.
|
|
4772
|
+
**request:** `Natural.ListWalletsRequest`
|
|
4741
4773
|
|
|
4742
4774
|
</dd>
|
|
4743
4775
|
</dl>
|
|
@@ -4745,7 +4777,7 @@ await client.externalAccounts.remove({
|
|
|
4745
4777
|
<dl>
|
|
4746
4778
|
<dd>
|
|
4747
4779
|
|
|
4748
|
-
**requestOptions:** `
|
|
4780
|
+
**requestOptions:** `WalletsClient.RequestOptions`
|
|
4749
4781
|
|
|
4750
4782
|
</dd>
|
|
4751
4783
|
</dl>
|
|
@@ -4757,8 +4789,7 @@ await client.externalAccounts.remove({
|
|
|
4757
4789
|
</dl>
|
|
4758
4790
|
</details>
|
|
4759
4791
|
|
|
4760
|
-
|
|
4761
|
-
<details><summary><code>client.externalParties.<a href="/src/api/resources/externalParties/client/Client.ts">list</a>({ ...params }) -> core.Page<Natural.ListExternalPartiesResponseDataItem, Natural.ExtParty></code></summary>
|
|
4792
|
+
<details><summary><code>client.wallets.<a href="/src/api/resources/wallets/client/Client.ts">create</a>({ ...params }) -> Natural.CreateWalletsResponse</code></summary>
|
|
4762
4793
|
<dl>
|
|
4763
4794
|
<dd>
|
|
4764
4795
|
|
|
@@ -4770,7 +4801,7 @@ await client.externalAccounts.remove({
|
|
|
4770
4801
|
<dl>
|
|
4771
4802
|
<dd>
|
|
4772
4803
|
|
|
4773
|
-
|
|
4804
|
+
Create a standard wallet
|
|
4774
4805
|
</dd>
|
|
4775
4806
|
</dl>
|
|
4776
4807
|
</dd>
|
|
@@ -4785,19 +4816,14 @@ List your external parties
|
|
|
4785
4816
|
<dd>
|
|
4786
4817
|
|
|
4787
4818
|
```typescript
|
|
4788
|
-
|
|
4789
|
-
|
|
4790
|
-
|
|
4791
|
-
|
|
4792
|
-
|
|
4793
|
-
|
|
4794
|
-
|
|
4795
|
-
|
|
4796
|
-
page = page.getNextPage();
|
|
4797
|
-
}
|
|
4798
|
-
|
|
4799
|
-
// You can also access the underlying response
|
|
4800
|
-
const response = page.response;
|
|
4819
|
+
await client.wallets.create({
|
|
4820
|
+
idempotencyKey: "Idempotency-Key",
|
|
4821
|
+
displayName: "Payroll",
|
|
4822
|
+
description: "Dedicated wallet for payroll runs",
|
|
4823
|
+
tags: {
|
|
4824
|
+
"department": "payroll"
|
|
4825
|
+
}
|
|
4826
|
+
});
|
|
4801
4827
|
|
|
4802
4828
|
```
|
|
4803
4829
|
</dd>
|
|
@@ -4813,7 +4839,7 @@ const response = page.response;
|
|
|
4813
4839
|
<dl>
|
|
4814
4840
|
<dd>
|
|
4815
4841
|
|
|
4816
|
-
**request:** `Natural.
|
|
4842
|
+
**request:** `Natural.CreateWalletsRequest`
|
|
4817
4843
|
|
|
4818
4844
|
</dd>
|
|
4819
4845
|
</dl>
|
|
@@ -4821,7 +4847,7 @@ const response = page.response;
|
|
|
4821
4847
|
<dl>
|
|
4822
4848
|
<dd>
|
|
4823
4849
|
|
|
4824
|
-
**requestOptions:** `
|
|
4850
|
+
**requestOptions:** `WalletsClient.RequestOptions`
|
|
4825
4851
|
|
|
4826
4852
|
</dd>
|
|
4827
4853
|
</dl>
|
|
@@ -4833,7 +4859,7 @@ const response = page.response;
|
|
|
4833
4859
|
</dl>
|
|
4834
4860
|
</details>
|
|
4835
4861
|
|
|
4836
|
-
<details><summary><code>client.
|
|
4862
|
+
<details><summary><code>client.wallets.<a href="/src/api/resources/wallets/client/Client.ts">get</a>({ ...params }) -> Natural.WalletDetail</code></summary>
|
|
4837
4863
|
<dl>
|
|
4838
4864
|
<dd>
|
|
4839
4865
|
|
|
@@ -4845,7 +4871,7 @@ const response = page.response;
|
|
|
4845
4871
|
<dl>
|
|
4846
4872
|
<dd>
|
|
4847
4873
|
|
|
4848
|
-
|
|
4874
|
+
Get a wallet
|
|
4849
4875
|
</dd>
|
|
4850
4876
|
</dl>
|
|
4851
4877
|
</dd>
|
|
@@ -4860,19 +4886,8 @@ Create an external party to transact with over Direct
|
|
|
4860
4886
|
<dd>
|
|
4861
4887
|
|
|
4862
4888
|
```typescript
|
|
4863
|
-
await client.
|
|
4864
|
-
|
|
4865
|
-
kind: "individual",
|
|
4866
|
-
name: "Jordan Rivera",
|
|
4867
|
-
email: "jordan@example.com",
|
|
4868
|
-
phone: "+1 415 555 0132",
|
|
4869
|
-
address: {
|
|
4870
|
-
line1: "123 Market St",
|
|
4871
|
-
city: "San Francisco",
|
|
4872
|
-
state: "CA",
|
|
4873
|
-
postalCode: "94105",
|
|
4874
|
-
countryCode: "US"
|
|
4875
|
-
}
|
|
4889
|
+
await client.wallets.get({
|
|
4890
|
+
walletId: "walletId"
|
|
4876
4891
|
});
|
|
4877
4892
|
|
|
4878
4893
|
```
|
|
@@ -4889,7 +4904,7 @@ await client.externalParties.create({
|
|
|
4889
4904
|
<dl>
|
|
4890
4905
|
<dd>
|
|
4891
4906
|
|
|
4892
|
-
**request:** `Natural.
|
|
4907
|
+
**request:** `Natural.GetWalletsRequest`
|
|
4893
4908
|
|
|
4894
4909
|
</dd>
|
|
4895
4910
|
</dl>
|
|
@@ -4897,7 +4912,7 @@ await client.externalParties.create({
|
|
|
4897
4912
|
<dl>
|
|
4898
4913
|
<dd>
|
|
4899
4914
|
|
|
4900
|
-
**requestOptions:** `
|
|
4915
|
+
**requestOptions:** `WalletsClient.RequestOptions`
|
|
4901
4916
|
|
|
4902
4917
|
</dd>
|
|
4903
4918
|
</dl>
|
|
@@ -4909,7 +4924,7 @@ await client.externalParties.create({
|
|
|
4909
4924
|
</dl>
|
|
4910
4925
|
</details>
|
|
4911
4926
|
|
|
4912
|
-
<details><summary><code>client.
|
|
4927
|
+
<details><summary><code>client.wallets.<a href="/src/api/resources/wallets/client/Client.ts">update</a>({ ...params }) -> Natural.UpdateWalletsResponse</code></summary>
|
|
4913
4928
|
<dl>
|
|
4914
4929
|
<dd>
|
|
4915
4930
|
|
|
@@ -4921,7 +4936,7 @@ await client.externalParties.create({
|
|
|
4921
4936
|
<dl>
|
|
4922
4937
|
<dd>
|
|
4923
4938
|
|
|
4924
|
-
|
|
4939
|
+
Update a wallet's display name, description, or tags
|
|
4925
4940
|
</dd>
|
|
4926
4941
|
</dl>
|
|
4927
4942
|
</dd>
|
|
@@ -4936,8 +4951,15 @@ Get an external party by ID
|
|
|
4936
4951
|
<dd>
|
|
4937
4952
|
|
|
4938
4953
|
```typescript
|
|
4939
|
-
await client.
|
|
4940
|
-
|
|
4954
|
+
await client.wallets.update({
|
|
4955
|
+
idempotencyKey: "Idempotency-Key",
|
|
4956
|
+
walletId: "walletId",
|
|
4957
|
+
displayName: "Operating (US)",
|
|
4958
|
+
description: "Primary USD operating wallet",
|
|
4959
|
+
tags: {
|
|
4960
|
+
"region": "us",
|
|
4961
|
+
"legacy_key": null
|
|
4962
|
+
}
|
|
4941
4963
|
});
|
|
4942
4964
|
|
|
4943
4965
|
```
|
|
@@ -4954,7 +4976,7 @@ await client.externalParties.get({
|
|
|
4954
4976
|
<dl>
|
|
4955
4977
|
<dd>
|
|
4956
4978
|
|
|
4957
|
-
**request:** `Natural.
|
|
4979
|
+
**request:** `Natural.UpdateWalletsRequest`
|
|
4958
4980
|
|
|
4959
4981
|
</dd>
|
|
4960
4982
|
</dl>
|
|
@@ -4962,7 +4984,7 @@ await client.externalParties.get({
|
|
|
4962
4984
|
<dl>
|
|
4963
4985
|
<dd>
|
|
4964
4986
|
|
|
4965
|
-
**requestOptions:** `
|
|
4987
|
+
**requestOptions:** `WalletsClient.RequestOptions`
|
|
4966
4988
|
|
|
4967
4989
|
</dd>
|
|
4968
4990
|
</dl>
|
|
@@ -4974,8 +4996,7 @@ await client.externalParties.get({
|
|
|
4974
4996
|
</dl>
|
|
4975
4997
|
</details>
|
|
4976
4998
|
|
|
4977
|
-
|
|
4978
|
-
<details><summary><code>client.externalPartyAccounts.<a href="/src/api/resources/externalPartyAccounts/client/Client.ts">list</a>({ ...params }) -> core.Page<Natural.ListExternalPartyAccountsResponseDataItem, Natural.ExtPartyAcct></code></summary>
|
|
4999
|
+
<details><summary><code>client.wallets.<a href="/src/api/resources/wallets/client/Client.ts">setDefault</a>({ ...params }) -> Natural.SetDefaultWalletsResponse</code></summary>
|
|
4979
5000
|
<dl>
|
|
4980
5001
|
<dd>
|
|
4981
5002
|
|
|
@@ -4987,7 +5008,7 @@ await client.externalParties.get({
|
|
|
4987
5008
|
<dl>
|
|
4988
5009
|
<dd>
|
|
4989
5010
|
|
|
4990
|
-
|
|
5011
|
+
Set the party's default wallet, where payments addressed to their email, phone number, or handle land
|
|
4991
5012
|
</dd>
|
|
4992
5013
|
</dl>
|
|
4993
5014
|
</dd>
|
|
@@ -5002,23 +5023,10 @@ List the accounts that belong to an external party
|
|
|
5002
5023
|
<dd>
|
|
5003
5024
|
|
|
5004
5025
|
```typescript
|
|
5005
|
-
|
|
5006
|
-
|
|
5007
|
-
|
|
5008
|
-
for await (const item of pageableResponse) {
|
|
5009
|
-
console.log(item);
|
|
5010
|
-
}
|
|
5011
|
-
|
|
5012
|
-
// Or you can manually iterate page-by-page
|
|
5013
|
-
let page = await client.externalPartyAccounts.list({
|
|
5014
|
-
externalPartyId: "externalPartyId"
|
|
5026
|
+
await client.wallets.setDefault({
|
|
5027
|
+
idempotencyKey: "Idempotency-Key",
|
|
5028
|
+
walletId: "walletId"
|
|
5015
5029
|
});
|
|
5016
|
-
while (page.hasNextPage()) {
|
|
5017
|
-
page = page.getNextPage();
|
|
5018
|
-
}
|
|
5019
|
-
|
|
5020
|
-
// You can also access the underlying response
|
|
5021
|
-
const response = page.response;
|
|
5022
5030
|
|
|
5023
5031
|
```
|
|
5024
5032
|
</dd>
|
|
@@ -5034,7 +5042,7 @@ const response = page.response;
|
|
|
5034
5042
|
<dl>
|
|
5035
5043
|
<dd>
|
|
5036
5044
|
|
|
5037
|
-
**request:** `Natural.
|
|
5045
|
+
**request:** `Natural.SetDefaultWalletsRequest`
|
|
5038
5046
|
|
|
5039
5047
|
</dd>
|
|
5040
5048
|
</dl>
|
|
@@ -5042,7 +5050,7 @@ const response = page.response;
|
|
|
5042
5050
|
<dl>
|
|
5043
5051
|
<dd>
|
|
5044
5052
|
|
|
5045
|
-
**requestOptions:** `
|
|
5053
|
+
**requestOptions:** `WalletsClient.RequestOptions`
|
|
5046
5054
|
|
|
5047
5055
|
</dd>
|
|
5048
5056
|
</dl>
|
|
@@ -5054,7 +5062,7 @@ const response = page.response;
|
|
|
5054
5062
|
</dl>
|
|
5055
5063
|
</details>
|
|
5056
5064
|
|
|
5057
|
-
<details><summary><code>client.
|
|
5065
|
+
<details><summary><code>client.wallets.<a href="/src/api/resources/wallets/client/Client.ts">freeze</a>({ ...params }) -> Natural.FreezeWalletsResponse</code></summary>
|
|
5058
5066
|
<dl>
|
|
5059
5067
|
<dd>
|
|
5060
5068
|
|
|
@@ -5066,7 +5074,7 @@ const response = page.response;
|
|
|
5066
5074
|
<dl>
|
|
5067
5075
|
<dd>
|
|
5068
5076
|
|
|
5069
|
-
|
|
5077
|
+
Freeze a wallet
|
|
5070
5078
|
</dd>
|
|
5071
5079
|
</dl>
|
|
5072
5080
|
</dd>
|
|
@@ -5081,16 +5089,8 @@ Store banking details for an external party
|
|
|
5081
5089
|
<dd>
|
|
5082
5090
|
|
|
5083
5091
|
```typescript
|
|
5084
|
-
await client.
|
|
5085
|
-
|
|
5086
|
-
externalPartyId: "epty_550e8400e29b41d4a716446655440000",
|
|
5087
|
-
accountDetails: {
|
|
5088
|
-
type: "us_bank_account",
|
|
5089
|
-
accountType: "checking",
|
|
5090
|
-
accountNumber: "123456786789",
|
|
5091
|
-
routingNumber: "121000358"
|
|
5092
|
-
},
|
|
5093
|
-
institutionName: "First National Bank"
|
|
5092
|
+
await client.wallets.freeze({
|
|
5093
|
+
walletId: "walletId"
|
|
5094
5094
|
});
|
|
5095
5095
|
|
|
5096
5096
|
```
|
|
@@ -5107,7 +5107,7 @@ await client.externalPartyAccounts.create({
|
|
|
5107
5107
|
<dl>
|
|
5108
5108
|
<dd>
|
|
5109
5109
|
|
|
5110
|
-
**request:** `Natural.
|
|
5110
|
+
**request:** `Natural.FreezeWalletsRequest`
|
|
5111
5111
|
|
|
5112
5112
|
</dd>
|
|
5113
5113
|
</dl>
|
|
@@ -5115,7 +5115,7 @@ await client.externalPartyAccounts.create({
|
|
|
5115
5115
|
<dl>
|
|
5116
5116
|
<dd>
|
|
5117
5117
|
|
|
5118
|
-
**requestOptions:** `
|
|
5118
|
+
**requestOptions:** `WalletsClient.RequestOptions`
|
|
5119
5119
|
|
|
5120
5120
|
</dd>
|
|
5121
5121
|
</dl>
|
|
@@ -5127,7 +5127,7 @@ await client.externalPartyAccounts.create({
|
|
|
5127
5127
|
</dl>
|
|
5128
5128
|
</details>
|
|
5129
5129
|
|
|
5130
|
-
<details><summary><code>client.
|
|
5130
|
+
<details><summary><code>client.wallets.<a href="/src/api/resources/wallets/client/Client.ts">unfreeze</a>({ ...params }) -> Natural.UnfreezeWalletsResponse</code></summary>
|
|
5131
5131
|
<dl>
|
|
5132
5132
|
<dd>
|
|
5133
5133
|
|
|
@@ -5139,7 +5139,7 @@ await client.externalPartyAccounts.create({
|
|
|
5139
5139
|
<dl>
|
|
5140
5140
|
<dd>
|
|
5141
5141
|
|
|
5142
|
-
|
|
5142
|
+
Unfreeze a wallet that was frozen through the API
|
|
5143
5143
|
</dd>
|
|
5144
5144
|
</dl>
|
|
5145
5145
|
</dd>
|
|
@@ -5154,8 +5154,8 @@ Get an external party account by ID
|
|
|
5154
5154
|
<dd>
|
|
5155
5155
|
|
|
5156
5156
|
```typescript
|
|
5157
|
-
await client.
|
|
5158
|
-
|
|
5157
|
+
await client.wallets.unfreeze({
|
|
5158
|
+
walletId: "walletId"
|
|
5159
5159
|
});
|
|
5160
5160
|
|
|
5161
5161
|
```
|
|
@@ -5172,7 +5172,7 @@ await client.externalPartyAccounts.get({
|
|
|
5172
5172
|
<dl>
|
|
5173
5173
|
<dd>
|
|
5174
5174
|
|
|
5175
|
-
**request:** `Natural.
|
|
5175
|
+
**request:** `Natural.UnfreezeWalletsRequest`
|
|
5176
5176
|
|
|
5177
5177
|
</dd>
|
|
5178
5178
|
</dl>
|
|
@@ -5180,7 +5180,7 @@ await client.externalPartyAccounts.get({
|
|
|
5180
5180
|
<dl>
|
|
5181
5181
|
<dd>
|
|
5182
5182
|
|
|
5183
|
-
**requestOptions:** `
|
|
5183
|
+
**requestOptions:** `WalletsClient.RequestOptions`
|
|
5184
5184
|
|
|
5185
5185
|
</dd>
|
|
5186
5186
|
</dl>
|
|
@@ -5192,8 +5192,7 @@ await client.externalPartyAccounts.get({
|
|
|
5192
5192
|
</dl>
|
|
5193
5193
|
</details>
|
|
5194
5194
|
|
|
5195
|
-
|
|
5196
|
-
<details><summary><code>client.ach.<a href="/src/api/resources/ach/client/Client.ts">list</a>({ ...params }) -> core.Page<Natural.ListAchResponseDataItem, Natural.Ach></code></summary>
|
|
5195
|
+
<details><summary><code>client.wallets.<a href="/src/api/resources/wallets/client/Client.ts">listAgents</a>({ ...params }) -> Natural.ListAgentsWalletsResponse</code></summary>
|
|
5197
5196
|
<dl>
|
|
5198
5197
|
<dd>
|
|
5199
5198
|
|
|
@@ -5205,7 +5204,7 @@ await client.externalPartyAccounts.get({
|
|
|
5205
5204
|
<dl>
|
|
5206
5205
|
<dd>
|
|
5207
5206
|
|
|
5208
|
-
List
|
|
5207
|
+
List agents granted access to a wallet
|
|
5209
5208
|
</dd>
|
|
5210
5209
|
</dl>
|
|
5211
5210
|
</dd>
|
|
@@ -5220,19 +5219,9 @@ List your ACH payments
|
|
|
5220
5219
|
<dd>
|
|
5221
5220
|
|
|
5222
5221
|
```typescript
|
|
5223
|
-
|
|
5224
|
-
|
|
5225
|
-
|
|
5226
|
-
}
|
|
5227
|
-
|
|
5228
|
-
// Or you can manually iterate page-by-page
|
|
5229
|
-
let page = await client.ach.list();
|
|
5230
|
-
while (page.hasNextPage()) {
|
|
5231
|
-
page = page.getNextPage();
|
|
5232
|
-
}
|
|
5233
|
-
|
|
5234
|
-
// You can also access the underlying response
|
|
5235
|
-
const response = page.response;
|
|
5222
|
+
await client.wallets.listAgents({
|
|
5223
|
+
walletId: "walletId"
|
|
5224
|
+
});
|
|
5236
5225
|
|
|
5237
5226
|
```
|
|
5238
5227
|
</dd>
|
|
@@ -5248,7 +5237,7 @@ const response = page.response;
|
|
|
5248
5237
|
<dl>
|
|
5249
5238
|
<dd>
|
|
5250
5239
|
|
|
5251
|
-
**request:** `Natural.
|
|
5240
|
+
**request:** `Natural.ListAgentsWalletsRequest`
|
|
5252
5241
|
|
|
5253
5242
|
</dd>
|
|
5254
5243
|
</dl>
|
|
@@ -5256,7 +5245,7 @@ const response = page.response;
|
|
|
5256
5245
|
<dl>
|
|
5257
5246
|
<dd>
|
|
5258
5247
|
|
|
5259
|
-
**requestOptions:** `
|
|
5248
|
+
**requestOptions:** `WalletsClient.RequestOptions`
|
|
5260
5249
|
|
|
5261
5250
|
</dd>
|
|
5262
5251
|
</dl>
|
|
@@ -5268,7 +5257,7 @@ const response = page.response;
|
|
|
5268
5257
|
</dl>
|
|
5269
5258
|
</details>
|
|
5270
5259
|
|
|
5271
|
-
<details><summary><code>client.
|
|
5260
|
+
<details><summary><code>client.wallets.<a href="/src/api/resources/wallets/client/Client.ts">attachAgent</a>({ ...params }) -> Natural.AttachAgentWalletsResponse</code></summary>
|
|
5272
5261
|
<dl>
|
|
5273
5262
|
<dd>
|
|
5274
5263
|
|
|
@@ -5280,7 +5269,7 @@ const response = page.response;
|
|
|
5280
5269
|
<dl>
|
|
5281
5270
|
<dd>
|
|
5282
5271
|
|
|
5283
|
-
|
|
5272
|
+
Grant an agent access to a wallet
|
|
5284
5273
|
</dd>
|
|
5285
5274
|
</dl>
|
|
5286
5275
|
</dd>
|
|
@@ -5295,13 +5284,10 @@ Create an ACH payment to an external party account
|
|
|
5295
5284
|
<dd>
|
|
5296
5285
|
|
|
5297
5286
|
```typescript
|
|
5298
|
-
await client.
|
|
5287
|
+
await client.wallets.attachAgent({
|
|
5299
5288
|
idempotencyKey: "Idempotency-Key",
|
|
5300
|
-
|
|
5301
|
-
|
|
5302
|
-
currency: "USD",
|
|
5303
|
-
externalPartyAccountId: "epa_550e8400e29b41d4a716446655440000",
|
|
5304
|
-
companyEntryDescription: "PAYOUT"
|
|
5289
|
+
walletId: "walletId",
|
|
5290
|
+
agentId: "agt_3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f"
|
|
5305
5291
|
});
|
|
5306
5292
|
|
|
5307
5293
|
```
|
|
@@ -5318,7 +5304,7 @@ await client.ach.create({
|
|
|
5318
5304
|
<dl>
|
|
5319
5305
|
<dd>
|
|
5320
5306
|
|
|
5321
|
-
**request:** `Natural.
|
|
5307
|
+
**request:** `Natural.AttachAgentWalletsRequest`
|
|
5322
5308
|
|
|
5323
5309
|
</dd>
|
|
5324
5310
|
</dl>
|
|
@@ -5326,7 +5312,7 @@ await client.ach.create({
|
|
|
5326
5312
|
<dl>
|
|
5327
5313
|
<dd>
|
|
5328
5314
|
|
|
5329
|
-
**requestOptions:** `
|
|
5315
|
+
**requestOptions:** `WalletsClient.RequestOptions`
|
|
5330
5316
|
|
|
5331
5317
|
</dd>
|
|
5332
5318
|
</dl>
|
|
@@ -5338,7 +5324,7 @@ await client.ach.create({
|
|
|
5338
5324
|
</dl>
|
|
5339
5325
|
</details>
|
|
5340
5326
|
|
|
5341
|
-
<details><summary><code>client.
|
|
5327
|
+
<details><summary><code>client.wallets.<a href="/src/api/resources/wallets/client/Client.ts">setAgentDefaultWallet</a>({ ...params }) -> Natural.SetAgentDefaultWalletWalletsResponse</code></summary>
|
|
5342
5328
|
<dl>
|
|
5343
5329
|
<dd>
|
|
5344
5330
|
|
|
@@ -5350,7 +5336,7 @@ await client.ach.create({
|
|
|
5350
5336
|
<dl>
|
|
5351
5337
|
<dd>
|
|
5352
5338
|
|
|
5353
|
-
|
|
5339
|
+
Make this wallet the default for the attached agent
|
|
5354
5340
|
</dd>
|
|
5355
5341
|
</dl>
|
|
5356
5342
|
</dd>
|
|
@@ -5365,8 +5351,10 @@ Get an ACH payment
|
|
|
5365
5351
|
<dd>
|
|
5366
5352
|
|
|
5367
5353
|
```typescript
|
|
5368
|
-
await client.
|
|
5369
|
-
|
|
5354
|
+
await client.wallets.setAgentDefaultWallet({
|
|
5355
|
+
idempotencyKey: "Idempotency-Key",
|
|
5356
|
+
walletId: "walletId",
|
|
5357
|
+
agentId: "agentId"
|
|
5370
5358
|
});
|
|
5371
5359
|
|
|
5372
5360
|
```
|
|
@@ -5383,7 +5371,7 @@ await client.ach.get({
|
|
|
5383
5371
|
<dl>
|
|
5384
5372
|
<dd>
|
|
5385
5373
|
|
|
5386
|
-
**request:** `Natural.
|
|
5374
|
+
**request:** `Natural.SetAgentDefaultWalletWalletsRequest`
|
|
5387
5375
|
|
|
5388
5376
|
</dd>
|
|
5389
5377
|
</dl>
|
|
@@ -5391,7 +5379,7 @@ await client.ach.get({
|
|
|
5391
5379
|
<dl>
|
|
5392
5380
|
<dd>
|
|
5393
5381
|
|
|
5394
|
-
**requestOptions:** `
|
|
5382
|
+
**requestOptions:** `WalletsClient.RequestOptions`
|
|
5395
5383
|
|
|
5396
5384
|
</dd>
|
|
5397
5385
|
</dl>
|
|
@@ -5403,7 +5391,7 @@ await client.ach.get({
|
|
|
5403
5391
|
</dl>
|
|
5404
5392
|
</details>
|
|
5405
5393
|
|
|
5406
|
-
<details><summary><code>client.
|
|
5394
|
+
<details><summary><code>client.wallets.<a href="/src/api/resources/wallets/client/Client.ts">detachAgent</a>({ ...params }) -> Natural.DetachAgentWalletsResponse</code></summary>
|
|
5407
5395
|
<dl>
|
|
5408
5396
|
<dd>
|
|
5409
5397
|
|
|
@@ -5415,7 +5403,7 @@ await client.ach.get({
|
|
|
5415
5403
|
<dl>
|
|
5416
5404
|
<dd>
|
|
5417
5405
|
|
|
5418
|
-
|
|
5406
|
+
Detach an agent from a wallet
|
|
5419
5407
|
</dd>
|
|
5420
5408
|
</dl>
|
|
5421
5409
|
</dd>
|
|
@@ -5430,10 +5418,10 @@ Cancel an ACH payment before submission
|
|
|
5430
5418
|
<dd>
|
|
5431
5419
|
|
|
5432
5420
|
```typescript
|
|
5433
|
-
await client.
|
|
5421
|
+
await client.wallets.detachAgent({
|
|
5434
5422
|
idempotencyKey: "Idempotency-Key",
|
|
5435
|
-
|
|
5436
|
-
|
|
5423
|
+
walletId: "walletId",
|
|
5424
|
+
agentId: "agentId"
|
|
5437
5425
|
});
|
|
5438
5426
|
|
|
5439
5427
|
```
|
|
@@ -5450,7 +5438,7 @@ await client.ach.cancel({
|
|
|
5450
5438
|
<dl>
|
|
5451
5439
|
<dd>
|
|
5452
5440
|
|
|
5453
|
-
**request:** `Natural.
|
|
5441
|
+
**request:** `Natural.DetachAgentWalletsRequest`
|
|
5454
5442
|
|
|
5455
5443
|
</dd>
|
|
5456
5444
|
</dl>
|
|
@@ -5458,7 +5446,7 @@ await client.ach.cancel({
|
|
|
5458
5446
|
<dl>
|
|
5459
5447
|
<dd>
|
|
5460
5448
|
|
|
5461
|
-
**requestOptions:** `
|
|
5449
|
+
**requestOptions:** `WalletsClient.RequestOptions`
|
|
5462
5450
|
|
|
5463
5451
|
</dd>
|
|
5464
5452
|
</dl>
|
|
@@ -5470,8 +5458,8 @@ await client.ach.cancel({
|
|
|
5470
5458
|
</dl>
|
|
5471
5459
|
</details>
|
|
5472
5460
|
|
|
5473
|
-
##
|
|
5474
|
-
<details><summary><code>client.
|
|
5461
|
+
## External Accounts
|
|
5462
|
+
<details><summary><code>client.externalAccounts.<a href="/src/api/resources/externalAccounts/client/Client.ts">createFromProcessorToken</a>({ ...params }) -> Natural.CreateFromProcessorTokenExternalAccountsResponse</code></summary>
|
|
5475
5463
|
<dl>
|
|
5476
5464
|
<dd>
|
|
5477
5465
|
|
|
@@ -5483,7 +5471,7 @@ await client.ach.cancel({
|
|
|
5483
5471
|
<dl>
|
|
5484
5472
|
<dd>
|
|
5485
5473
|
|
|
5486
|
-
|
|
5474
|
+
Link or refresh a bank account using a Plaid processor token
|
|
5487
5475
|
</dd>
|
|
5488
5476
|
</dl>
|
|
5489
5477
|
</dd>
|
|
@@ -5498,7 +5486,15 @@ List your realtime payments
|
|
|
5498
5486
|
<dd>
|
|
5499
5487
|
|
|
5500
5488
|
```typescript
|
|
5501
|
-
await client.
|
|
5489
|
+
await client.externalAccounts.createFromProcessorToken({
|
|
5490
|
+
idempotencyKey: "Idempotency-Key",
|
|
5491
|
+
partyId: "pty_550e8400e29b41d4a716446655440000",
|
|
5492
|
+
processorToken: "processor-sandbox-abc123",
|
|
5493
|
+
institutionName: "Plaid Sandbox",
|
|
5494
|
+
tags: {
|
|
5495
|
+
"environment": "sandbox"
|
|
5496
|
+
}
|
|
5497
|
+
});
|
|
5502
5498
|
|
|
5503
5499
|
```
|
|
5504
5500
|
</dd>
|
|
@@ -5514,7 +5510,7 @@ await client.realtime.list();
|
|
|
5514
5510
|
<dl>
|
|
5515
5511
|
<dd>
|
|
5516
5512
|
|
|
5517
|
-
**request:** `Natural.
|
|
5513
|
+
**request:** `Natural.CreateFromProcessorTokenExternalAccountsRequest`
|
|
5518
5514
|
|
|
5519
5515
|
</dd>
|
|
5520
5516
|
</dl>
|
|
@@ -5522,7 +5518,7 @@ await client.realtime.list();
|
|
|
5522
5518
|
<dl>
|
|
5523
5519
|
<dd>
|
|
5524
5520
|
|
|
5525
|
-
**requestOptions:** `
|
|
5521
|
+
**requestOptions:** `ExternalAccountsClient.RequestOptions`
|
|
5526
5522
|
|
|
5527
5523
|
</dd>
|
|
5528
5524
|
</dl>
|
|
@@ -5534,7 +5530,7 @@ await client.realtime.list();
|
|
|
5534
5530
|
</dl>
|
|
5535
5531
|
</details>
|
|
5536
5532
|
|
|
5537
|
-
<details><summary><code>client.
|
|
5533
|
+
<details><summary><code>client.externalAccounts.<a href="/src/api/resources/externalAccounts/client/Client.ts">list</a>({ ...params }) -> core.Page<Natural.ListExternalAccountsResponseDataItem, Natural.ExtAcct></code></summary>
|
|
5538
5534
|
<dl>
|
|
5539
5535
|
<dd>
|
|
5540
5536
|
|
|
@@ -5546,7 +5542,7 @@ await client.realtime.list();
|
|
|
5546
5542
|
<dl>
|
|
5547
5543
|
<dd>
|
|
5548
5544
|
|
|
5549
|
-
|
|
5545
|
+
List linked external accounts
|
|
5550
5546
|
</dd>
|
|
5551
5547
|
</dl>
|
|
5552
5548
|
</dd>
|
|
@@ -5561,13 +5557,19 @@ Create a realtime payment to an external party account
|
|
|
5561
5557
|
<dd>
|
|
5562
5558
|
|
|
5563
5559
|
```typescript
|
|
5564
|
-
await client.
|
|
5565
|
-
|
|
5566
|
-
|
|
5567
|
-
|
|
5568
|
-
|
|
5569
|
-
|
|
5570
|
-
|
|
5560
|
+
const pageableResponse = await client.externalAccounts.list();
|
|
5561
|
+
for await (const item of pageableResponse) {
|
|
5562
|
+
console.log(item);
|
|
5563
|
+
}
|
|
5564
|
+
|
|
5565
|
+
// Or you can manually iterate page-by-page
|
|
5566
|
+
let page = await client.externalAccounts.list();
|
|
5567
|
+
while (page.hasNextPage()) {
|
|
5568
|
+
page = page.getNextPage();
|
|
5569
|
+
}
|
|
5570
|
+
|
|
5571
|
+
// You can also access the underlying response
|
|
5572
|
+
const response = page.response;
|
|
5571
5573
|
|
|
5572
5574
|
```
|
|
5573
5575
|
</dd>
|
|
@@ -5583,7 +5585,7 @@ await client.realtime.create({
|
|
|
5583
5585
|
<dl>
|
|
5584
5586
|
<dd>
|
|
5585
5587
|
|
|
5586
|
-
**request:** `Natural.
|
|
5588
|
+
**request:** `Natural.ListExternalAccountsRequest`
|
|
5587
5589
|
|
|
5588
5590
|
</dd>
|
|
5589
5591
|
</dl>
|
|
@@ -5591,7 +5593,7 @@ await client.realtime.create({
|
|
|
5591
5593
|
<dl>
|
|
5592
5594
|
<dd>
|
|
5593
5595
|
|
|
5594
|
-
**requestOptions:** `
|
|
5596
|
+
**requestOptions:** `ExternalAccountsClient.RequestOptions`
|
|
5595
5597
|
|
|
5596
5598
|
</dd>
|
|
5597
5599
|
</dl>
|
|
@@ -5603,7 +5605,7 @@ await client.realtime.create({
|
|
|
5603
5605
|
</dl>
|
|
5604
5606
|
</details>
|
|
5605
5607
|
|
|
5606
|
-
<details><summary><code>client.
|
|
5608
|
+
<details><summary><code>client.externalAccounts.<a href="/src/api/resources/externalAccounts/client/Client.ts">get</a>({ ...params }) -> Natural.GetExternalAccountsResponse</code></summary>
|
|
5607
5609
|
<dl>
|
|
5608
5610
|
<dd>
|
|
5609
5611
|
|
|
@@ -5615,7 +5617,7 @@ await client.realtime.create({
|
|
|
5615
5617
|
<dl>
|
|
5616
5618
|
<dd>
|
|
5617
5619
|
|
|
5618
|
-
Get a
|
|
5620
|
+
Get a linked external account
|
|
5619
5621
|
</dd>
|
|
5620
5622
|
</dl>
|
|
5621
5623
|
</dd>
|
|
@@ -5630,8 +5632,8 @@ Get a realtime payment
|
|
|
5630
5632
|
<dd>
|
|
5631
5633
|
|
|
5632
5634
|
```typescript
|
|
5633
|
-
await client.
|
|
5634
|
-
|
|
5635
|
+
await client.externalAccounts.get({
|
|
5636
|
+
externalAccountId: "externalAccountId"
|
|
5635
5637
|
});
|
|
5636
5638
|
|
|
5637
5639
|
```
|
|
@@ -5648,7 +5650,7 @@ await client.realtime.get({
|
|
|
5648
5650
|
<dl>
|
|
5649
5651
|
<dd>
|
|
5650
5652
|
|
|
5651
|
-
**request:** `Natural.
|
|
5653
|
+
**request:** `Natural.GetExternalAccountsRequest`
|
|
5652
5654
|
|
|
5653
5655
|
</dd>
|
|
5654
5656
|
</dl>
|
|
@@ -5656,7 +5658,7 @@ await client.realtime.get({
|
|
|
5656
5658
|
<dl>
|
|
5657
5659
|
<dd>
|
|
5658
5660
|
|
|
5659
|
-
**requestOptions:** `
|
|
5661
|
+
**requestOptions:** `ExternalAccountsClient.RequestOptions`
|
|
5660
5662
|
|
|
5661
5663
|
</dd>
|
|
5662
5664
|
</dl>
|
|
@@ -5668,7 +5670,7 @@ await client.realtime.get({
|
|
|
5668
5670
|
</dl>
|
|
5669
5671
|
</details>
|
|
5670
5672
|
|
|
5671
|
-
<details><summary><code>client.
|
|
5673
|
+
<details><summary><code>client.externalAccounts.<a href="/src/api/resources/externalAccounts/client/Client.ts">remove</a>({ ...params }) -> Natural.DelExtAcct</code></summary>
|
|
5672
5674
|
<dl>
|
|
5673
5675
|
<dd>
|
|
5674
5676
|
|
|
@@ -5680,7 +5682,7 @@ await client.realtime.get({
|
|
|
5680
5682
|
<dl>
|
|
5681
5683
|
<dd>
|
|
5682
5684
|
|
|
5683
|
-
|
|
5685
|
+
Remove a linked external account
|
|
5684
5686
|
</dd>
|
|
5685
5687
|
</dl>
|
|
5686
5688
|
</dd>
|
|
@@ -5695,10 +5697,8 @@ Cancel a realtime payment before submission
|
|
|
5695
5697
|
<dd>
|
|
5696
5698
|
|
|
5697
5699
|
```typescript
|
|
5698
|
-
await client.
|
|
5699
|
-
|
|
5700
|
-
realtimeId: "realtimeId",
|
|
5701
|
-
reason: "Duplicate payment"
|
|
5700
|
+
await client.externalAccounts.remove({
|
|
5701
|
+
externalAccountId: "externalAccountId"
|
|
5702
5702
|
});
|
|
5703
5703
|
|
|
5704
5704
|
```
|
|
@@ -5715,7 +5715,7 @@ await client.realtime.cancel({
|
|
|
5715
5715
|
<dl>
|
|
5716
5716
|
<dd>
|
|
5717
5717
|
|
|
5718
|
-
**request:** `Natural.
|
|
5718
|
+
**request:** `Natural.RemoveExternalAccountsRequest`
|
|
5719
5719
|
|
|
5720
5720
|
</dd>
|
|
5721
5721
|
</dl>
|
|
@@ -5723,7 +5723,7 @@ await client.realtime.cancel({
|
|
|
5723
5723
|
<dl>
|
|
5724
5724
|
<dd>
|
|
5725
5725
|
|
|
5726
|
-
**requestOptions:** `
|
|
5726
|
+
**requestOptions:** `ExternalAccountsClient.RequestOptions`
|
|
5727
5727
|
|
|
5728
5728
|
</dd>
|
|
5729
5729
|
</dl>
|