@payabli/sdk-node 0.0.140 → 0.0.142
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/README.md +11 -15
- package/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/Client.d.ts +3 -0
- package/dist/cjs/Client.js +41 -36
- package/dist/cjs/api/resources/bill/types/BillOutData.d.ts +5 -1
- package/dist/cjs/api/resources/cloud/client/Client.d.ts +4 -0
- package/dist/cjs/api/resources/cloud/client/Client.js +4 -0
- package/dist/cjs/api/resources/index.d.ts +4 -0
- package/dist/cjs/api/resources/index.js +5 -1
- package/dist/cjs/api/resources/management/client/Client.d.ts +41 -0
- package/dist/cjs/api/resources/management/client/Client.js +131 -0
- package/dist/cjs/api/resources/management/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/management/client/index.js +17 -0
- package/dist/cjs/api/resources/management/client/requests/VerifyAccountDetailsRequest.d.ts +25 -0
- package/dist/cjs/api/resources/management/client/requests/VerifyAccountDetailsRequest.js +3 -0
- package/dist/cjs/api/resources/management/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/management/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/management/exports.d.ts +2 -0
- package/dist/cjs/api/resources/management/exports.js +21 -0
- package/dist/cjs/api/resources/management/index.d.ts +2 -0
- package/dist/cjs/api/resources/management/index.js +18 -0
- package/dist/cjs/api/resources/management/types/BankAccountVerificationDetailsResponse.d.ts +31 -0
- package/dist/cjs/api/resources/management/types/BankAccountVerificationDetailsResponse.js +3 -0
- package/dist/cjs/api/resources/management/types/VerifyAccountDetailsResponse.d.ts +9 -0
- package/dist/cjs/api/resources/management/types/VerifyAccountDetailsResponse.js +3 -0
- package/dist/cjs/api/resources/management/types/index.d.ts +2 -0
- package/dist/cjs/api/resources/management/types/index.js +18 -0
- package/dist/cjs/api/resources/moneyIn/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/moneyIn/client/Client.js +1 -1
- package/dist/cjs/api/resources/moneyIn/types/TransactionDetailPaymentData.d.ts +1 -1
- package/dist/cjs/api/resources/moneyOut/client/Client.d.ts +5 -2
- package/dist/cjs/api/resources/moneyOut/client/Client.js +5 -2
- package/dist/cjs/api/resources/moneyOut/client/requests/MoneyOutTypesRequestOutAuthorize.d.ts +3 -0
- package/dist/cjs/api/resources/moneyOutTypes/types/AuthorizePayoutBody.d.ts +1 -0
- package/dist/cjs/api/resources/payoutSubscription/types/GetPayoutSubscriptionResponse.d.ts +7 -0
- package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecord.d.ts +7 -0
- package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecordPascal.d.ts +7 -0
- package/dist/cjs/api/resources/payoutSubscription/types/QueryPayoutSubscriptionResponse.d.ts +7 -0
- package/dist/cjs/api/resources/query/client/Client.d.ts +42 -0
- package/dist/cjs/api/resources/query/client/Client.js +140 -0
- package/dist/cjs/api/resources/query/client/requests/ListDevicesOrgRequest.d.ts +113 -0
- package/dist/cjs/api/resources/query/client/requests/ListDevicesOrgRequest.js +3 -0
- package/dist/cjs/api/resources/query/client/requests/ListDevicesRequest.d.ts +113 -0
- package/dist/cjs/api/resources/query/client/requests/ListDevicesRequest.js +3 -0
- package/dist/cjs/api/resources/query/client/requests/ListVcardsOrgRequest.d.ts +1 -0
- package/dist/cjs/api/resources/query/client/requests/ListVcardsRequest.d.ts +1 -0
- package/dist/cjs/api/resources/query/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/queryTypes/types/DeviceQueryRecord.d.ts +50 -0
- package/dist/cjs/api/resources/queryTypes/types/DeviceQueryRecord.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/QueryDeviceResponse.d.ts +45 -0
- package/dist/cjs/api/resources/queryTypes/types/QueryDeviceResponse.js +3 -0
- package/dist/cjs/api/resources/queryTypes/types/index.d.ts +2 -0
- package/dist/cjs/api/resources/queryTypes/types/index.js +2 -0
- package/dist/cjs/api/resources/vendor/client/Client.d.ts +44 -1
- package/dist/cjs/api/resources/vendor/client/Client.js +88 -1
- package/dist/cjs/api/resources/vendor/index.d.ts +1 -0
- package/dist/cjs/api/resources/vendor/index.js +1 -0
- package/dist/cjs/api/resources/vendor/types/VendorEnrichRequest.d.ts +20 -0
- package/dist/cjs/api/resources/vendor/types/VendorEnrichRequest.js +3 -0
- package/dist/cjs/api/resources/vendor/types/VendorEnrichResponse.d.ts +12 -0
- package/dist/cjs/api/resources/vendor/types/VendorEnrichResponse.js +3 -0
- package/dist/cjs/api/resources/vendor/types/VendorEnrichResponseData.d.ts +16 -0
- package/dist/cjs/api/resources/vendor/types/VendorEnrichResponseData.js +3 -0
- package/dist/cjs/api/resources/vendor/types/VendorEnrichmentData.d.ts +10 -0
- package/dist/cjs/api/resources/vendor/types/VendorEnrichmentData.js +3 -0
- package/dist/cjs/api/resources/vendor/types/VendorEnrichmentInvoiceScan.d.ts +35 -0
- package/dist/cjs/api/resources/vendor/types/VendorEnrichmentInvoiceScan.js +3 -0
- package/dist/cjs/api/resources/vendor/types/VendorEnrichmentWebSearch.d.ts +35 -0
- package/dist/cjs/api/resources/vendor/types/VendorEnrichmentWebSearch.js +3 -0
- package/dist/cjs/api/resources/vendor/types/index.d.ts +6 -0
- package/dist/cjs/api/resources/vendor/types/index.js +22 -0
- package/dist/cjs/api/types/AutoCapture.d.ts +4 -0
- package/dist/cjs/api/types/AutoCapture.js +3 -0
- package/dist/cjs/api/types/BinData.d.ts +4 -1
- package/dist/cjs/api/types/NotificationContent.d.ts +0 -1
- package/dist/cjs/api/types/NotificationContent.js +0 -1
- package/dist/cjs/api/types/NotificationStandardRequest.d.ts +0 -1
- package/dist/cjs/api/types/NotificationStandardRequest.js +0 -1
- package/dist/cjs/api/types/ProcessingSection.d.ts +5 -0
- package/dist/cjs/api/types/QueryChargebacksResponse.d.ts +10 -1
- package/dist/cjs/api/types/TemplateElement.d.ts +1 -0
- package/dist/cjs/api/types/VCardCardType.d.ts +6 -0
- package/dist/cjs/api/types/VCardCardType.js +3 -0
- package/dist/cjs/api/types/VCardRecord.d.ts +2 -0
- package/dist/cjs/api/types/VendorData.d.ts +12 -0
- package/dist/cjs/api/types/VendorQueryRecord.d.ts +21 -0
- package/dist/cjs/api/types/index.d.ts +2 -0
- package/dist/cjs/api/types/index.js +2 -0
- 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 +3 -0
- package/dist/esm/Client.mjs +5 -0
- package/dist/esm/api/resources/bill/types/BillOutData.d.mts +5 -1
- package/dist/esm/api/resources/cloud/client/Client.d.mts +4 -0
- package/dist/esm/api/resources/cloud/client/Client.mjs +4 -0
- package/dist/esm/api/resources/index.d.mts +4 -0
- package/dist/esm/api/resources/index.mjs +4 -0
- package/dist/esm/api/resources/management/client/Client.d.mts +41 -0
- package/dist/esm/api/resources/management/client/Client.mjs +94 -0
- package/dist/esm/api/resources/management/client/index.d.mts +1 -0
- package/dist/esm/api/resources/management/client/index.mjs +1 -0
- package/dist/esm/api/resources/management/client/requests/VerifyAccountDetailsRequest.d.mts +25 -0
- package/dist/esm/api/resources/management/client/requests/VerifyAccountDetailsRequest.mjs +2 -0
- package/dist/esm/api/resources/management/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/management/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/management/exports.d.mts +2 -0
- package/dist/esm/api/resources/management/exports.mjs +3 -0
- package/dist/esm/api/resources/management/index.d.mts +2 -0
- package/dist/esm/api/resources/management/index.mjs +2 -0
- package/dist/esm/api/resources/management/types/BankAccountVerificationDetailsResponse.d.mts +31 -0
- package/dist/esm/api/resources/management/types/BankAccountVerificationDetailsResponse.mjs +2 -0
- package/dist/esm/api/resources/management/types/VerifyAccountDetailsResponse.d.mts +9 -0
- package/dist/esm/api/resources/management/types/VerifyAccountDetailsResponse.mjs +2 -0
- package/dist/esm/api/resources/management/types/index.d.mts +2 -0
- package/dist/esm/api/resources/management/types/index.mjs +2 -0
- package/dist/esm/api/resources/moneyIn/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/moneyIn/client/Client.mjs +1 -1
- package/dist/esm/api/resources/moneyIn/types/TransactionDetailPaymentData.d.mts +1 -1
- package/dist/esm/api/resources/moneyOut/client/Client.d.mts +5 -2
- package/dist/esm/api/resources/moneyOut/client/Client.mjs +5 -2
- package/dist/esm/api/resources/moneyOut/client/requests/MoneyOutTypesRequestOutAuthorize.d.mts +3 -0
- package/dist/esm/api/resources/moneyOutTypes/types/AuthorizePayoutBody.d.mts +1 -0
- package/dist/esm/api/resources/payoutSubscription/types/GetPayoutSubscriptionResponse.d.mts +7 -0
- package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecord.d.mts +7 -0
- package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecordPascal.d.mts +7 -0
- package/dist/esm/api/resources/payoutSubscription/types/QueryPayoutSubscriptionResponse.d.mts +7 -0
- package/dist/esm/api/resources/query/client/Client.d.mts +42 -0
- package/dist/esm/api/resources/query/client/Client.mjs +140 -0
- package/dist/esm/api/resources/query/client/requests/ListDevicesOrgRequest.d.mts +113 -0
- package/dist/esm/api/resources/query/client/requests/ListDevicesOrgRequest.mjs +2 -0
- package/dist/esm/api/resources/query/client/requests/ListDevicesRequest.d.mts +113 -0
- package/dist/esm/api/resources/query/client/requests/ListDevicesRequest.mjs +2 -0
- package/dist/esm/api/resources/query/client/requests/ListVcardsOrgRequest.d.mts +1 -0
- package/dist/esm/api/resources/query/client/requests/ListVcardsRequest.d.mts +1 -0
- package/dist/esm/api/resources/query/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/queryTypes/types/DeviceQueryRecord.d.mts +50 -0
- package/dist/esm/api/resources/queryTypes/types/DeviceQueryRecord.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/QueryDeviceResponse.d.mts +45 -0
- package/dist/esm/api/resources/queryTypes/types/QueryDeviceResponse.mjs +2 -0
- package/dist/esm/api/resources/queryTypes/types/index.d.mts +2 -0
- package/dist/esm/api/resources/queryTypes/types/index.mjs +2 -0
- package/dist/esm/api/resources/vendor/client/Client.d.mts +44 -1
- package/dist/esm/api/resources/vendor/client/Client.mjs +88 -1
- package/dist/esm/api/resources/vendor/index.d.mts +1 -0
- package/dist/esm/api/resources/vendor/index.mjs +1 -0
- package/dist/esm/api/resources/vendor/types/VendorEnrichRequest.d.mts +20 -0
- package/dist/esm/api/resources/vendor/types/VendorEnrichRequest.mjs +2 -0
- package/dist/esm/api/resources/vendor/types/VendorEnrichResponse.d.mts +12 -0
- package/dist/esm/api/resources/vendor/types/VendorEnrichResponse.mjs +2 -0
- package/dist/esm/api/resources/vendor/types/VendorEnrichResponseData.d.mts +16 -0
- package/dist/esm/api/resources/vendor/types/VendorEnrichResponseData.mjs +2 -0
- package/dist/esm/api/resources/vendor/types/VendorEnrichmentData.d.mts +10 -0
- package/dist/esm/api/resources/vendor/types/VendorEnrichmentData.mjs +2 -0
- package/dist/esm/api/resources/vendor/types/VendorEnrichmentInvoiceScan.d.mts +35 -0
- package/dist/esm/api/resources/vendor/types/VendorEnrichmentInvoiceScan.mjs +2 -0
- package/dist/esm/api/resources/vendor/types/VendorEnrichmentWebSearch.d.mts +35 -0
- package/dist/esm/api/resources/vendor/types/VendorEnrichmentWebSearch.mjs +2 -0
- package/dist/esm/api/resources/vendor/types/index.d.mts +6 -0
- package/dist/esm/api/resources/vendor/types/index.mjs +6 -0
- package/dist/esm/api/types/AutoCapture.d.mts +4 -0
- package/dist/esm/api/types/AutoCapture.mjs +2 -0
- package/dist/esm/api/types/BinData.d.mts +4 -1
- package/dist/esm/api/types/NotificationContent.d.mts +0 -1
- package/dist/esm/api/types/NotificationContent.mjs +0 -1
- package/dist/esm/api/types/NotificationStandardRequest.d.mts +0 -1
- package/dist/esm/api/types/NotificationStandardRequest.mjs +0 -1
- package/dist/esm/api/types/ProcessingSection.d.mts +5 -0
- package/dist/esm/api/types/QueryChargebacksResponse.d.mts +10 -1
- package/dist/esm/api/types/TemplateElement.d.mts +1 -0
- package/dist/esm/api/types/VCardCardType.d.mts +6 -0
- package/dist/esm/api/types/VCardCardType.mjs +2 -0
- package/dist/esm/api/types/VCardRecord.d.mts +2 -0
- package/dist/esm/api/types/VendorData.d.mts +12 -0
- package/dist/esm/api/types/VendorQueryRecord.d.mts +21 -0
- package/dist/esm/api/types/index.d.mts +2 -0
- package/dist/esm/api/types/index.mjs +2 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +12 -1
- package/reference.md +321 -4
|
@@ -77,6 +77,13 @@ import type * as Payabli from "../index.mjs";
|
|
|
77
77
|
* customField2: "",
|
|
78
78
|
* customerVendorAccount: "123-456",
|
|
79
79
|
* InternalReferenceId: 1000000,
|
|
80
|
+
* PaymentPortalUrl: "https://greenfield-landscaping.com/pay",
|
|
81
|
+
* CardAccepted: "yes",
|
|
82
|
+
* AchAccepted: "unable to determine",
|
|
83
|
+
* EnrichmentStatus: "fully_enriched",
|
|
84
|
+
* EnrichedBy: "web_search",
|
|
85
|
+
* EnrichedAt: "2026-03-05T14:22:10Z",
|
|
86
|
+
* EnrichmentId: "enrich-3890-a1b2c3d4",
|
|
80
87
|
* externalPaypointID: "Paypoint-100",
|
|
81
88
|
* StoredMethods: []
|
|
82
89
|
* }
|
|
@@ -126,4 +133,18 @@ export interface VendorQueryRecord {
|
|
|
126
133
|
VendorNumber?: Payabli.VendorNumber | undefined;
|
|
127
134
|
VendorStatus?: Payabli.Vendorstatus | undefined;
|
|
128
135
|
Zip?: Payabli.Zip | undefined;
|
|
136
|
+
/** URL for the vendor's online payment portal, if known. Populated by the vendor enrichment pipeline. */
|
|
137
|
+
PaymentPortalUrl?: string | undefined;
|
|
138
|
+
/** Whether the vendor accepts card payments. Values are `yes`, `no`, or `unable to determine`. Populated by the vendor enrichment pipeline. */
|
|
139
|
+
CardAccepted?: string | undefined;
|
|
140
|
+
/** Whether the vendor accepts ACH payments. Values are `yes`, `no`, or `unable to determine`. Populated by the vendor enrichment pipeline. */
|
|
141
|
+
AchAccepted?: string | undefined;
|
|
142
|
+
/** Current enrichment state of the vendor. Values are `not_enriched`, `partially_enriched`, `fully_enriched`, or `fallback_applied`. */
|
|
143
|
+
EnrichmentStatus?: string | undefined;
|
|
144
|
+
/** Which enrichment method resolved the vendor's payment acceptance info. Values are `invoice_scan`, `web_search`, `vendor_network`, or `manual`. */
|
|
145
|
+
EnrichedBy?: string | undefined;
|
|
146
|
+
/** When the vendor was last enriched (UTC). */
|
|
147
|
+
EnrichedAt?: string | undefined;
|
|
148
|
+
/** Identifier for the enrichment request that last updated this vendor. */
|
|
149
|
+
EnrichmentId?: string | undefined;
|
|
129
150
|
}
|
|
@@ -55,6 +55,7 @@ export * from "./AssociatedVendor.mjs";
|
|
|
55
55
|
export * from "./Attachments.mjs";
|
|
56
56
|
export * from "./AttestationDate.mjs";
|
|
57
57
|
export * from "./Authcode.mjs";
|
|
58
|
+
export * from "./AutoCapture.mjs";
|
|
58
59
|
export * from "./AutoElement.mjs";
|
|
59
60
|
export * from "./Avgmonthly.mjs";
|
|
60
61
|
export * from "./Avgticketamt.mjs";
|
|
@@ -561,6 +562,7 @@ export * from "./UserQueryRecord.mjs";
|
|
|
561
562
|
export * from "./UsrAccess.mjs";
|
|
562
563
|
export * from "./UsrStatus.mjs";
|
|
563
564
|
export * from "./ValueTemplates.mjs";
|
|
565
|
+
export * from "./VCardCardType.mjs";
|
|
564
566
|
export * from "./VCardQueryResponse.mjs";
|
|
565
567
|
export * from "./VCardRecord.mjs";
|
|
566
568
|
export * from "./VCardSummary.mjs";
|
|
@@ -55,6 +55,7 @@ export * from "./AssociatedVendor.mjs";
|
|
|
55
55
|
export * from "./Attachments.mjs";
|
|
56
56
|
export * from "./AttestationDate.mjs";
|
|
57
57
|
export * from "./Authcode.mjs";
|
|
58
|
+
export * from "./AutoCapture.mjs";
|
|
58
59
|
export * from "./AutoElement.mjs";
|
|
59
60
|
export * from "./Avgmonthly.mjs";
|
|
60
61
|
export * from "./Avgticketamt.mjs";
|
|
@@ -561,6 +562,7 @@ export * from "./UserQueryRecord.mjs";
|
|
|
561
562
|
export * from "./UsrAccess.mjs";
|
|
562
563
|
export * from "./UsrStatus.mjs";
|
|
563
564
|
export * from "./ValueTemplates.mjs";
|
|
565
|
+
export * from "./VCardCardType.mjs";
|
|
564
566
|
export * from "./VCardQueryResponse.mjs";
|
|
565
567
|
export * from "./VCardRecord.mjs";
|
|
566
568
|
export * from "./VCardSummary.mjs";
|
package/dist/esm/version.d.mts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const SDK_VERSION = "0.0.
|
|
1
|
+
export declare const SDK_VERSION = "0.0.142";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "0.0.
|
|
1
|
+
export const SDK_VERSION = "0.0.142";
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@payabli/sdk-node",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.142",
|
|
4
4
|
"private": false,
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -154,6 +154,17 @@
|
|
|
154
154
|
},
|
|
155
155
|
"default": "./dist/cjs/api/resources/lineItem/exports.js"
|
|
156
156
|
},
|
|
157
|
+
"./management": {
|
|
158
|
+
"import": {
|
|
159
|
+
"types": "./dist/esm/api/resources/management/exports.d.mts",
|
|
160
|
+
"default": "./dist/esm/api/resources/management/exports.mjs"
|
|
161
|
+
},
|
|
162
|
+
"require": {
|
|
163
|
+
"types": "./dist/cjs/api/resources/management/exports.d.ts",
|
|
164
|
+
"default": "./dist/cjs/api/resources/management/exports.js"
|
|
165
|
+
},
|
|
166
|
+
"default": "./dist/cjs/api/resources/management/exports.js"
|
|
167
|
+
},
|
|
157
168
|
"./moneyIn": {
|
|
158
169
|
"import": {
|
|
159
170
|
"types": "./dist/esm/api/resources/moneyIn/exports.d.mts",
|
package/reference.md
CHANGED
|
@@ -2179,6 +2179,8 @@ await client.cloud.historyDevice("8cfec329267", "WXGDWB");
|
|
|
2179
2179
|
<dl>
|
|
2180
2180
|
<dd>
|
|
2181
2181
|
|
|
2182
|
+
Use [List devices by paypoint](/developers/api-reference/cloud/get-list-of-devices-for-a-paypoint) instead, which supports filters, sorting, and pagination.
|
|
2183
|
+
|
|
2182
2184
|
Get a list of cloud devices registered to an entrypoint.
|
|
2183
2185
|
</dd>
|
|
2184
2186
|
</dl>
|
|
@@ -6952,6 +6954,89 @@ await client.lineItem.updateItem(700, {
|
|
|
6952
6954
|
</dl>
|
|
6953
6955
|
|
|
6954
6956
|
|
|
6957
|
+
</dd>
|
|
6958
|
+
</dl>
|
|
6959
|
+
</details>
|
|
6960
|
+
|
|
6961
|
+
## Management
|
|
6962
|
+
<details><summary><code>client.management.<a href="/src/api/resources/management/client/Client.ts">verifyAccountDetails</a>(entry, { ...params }) -> Payabli.VerifyAccountDetailsResponse</code></summary>
|
|
6963
|
+
<dl>
|
|
6964
|
+
<dd>
|
|
6965
|
+
|
|
6966
|
+
#### 📝 Description
|
|
6967
|
+
|
|
6968
|
+
<dl>
|
|
6969
|
+
<dd>
|
|
6970
|
+
|
|
6971
|
+
<dl>
|
|
6972
|
+
<dd>
|
|
6973
|
+
|
|
6974
|
+
Verifies a bank account and returns detailed verification results from the verification network, including bank name, account status, and response codes. Unlike a pass/fail verification, this endpoint returns granular data to support decision-making and troubleshooting.
|
|
6975
|
+
|
|
6976
|
+
When bank authentication is enabled for the paypoint's organization, the endpoint performs an identity verification check on the account holder. Otherwise, it performs an account existence check. When bank authentication is enabled, the `accountHolderType` and `holderName` fields are required.
|
|
6977
|
+
|
|
6978
|
+
Requires `inboundpayments_create` or `outboundpayments_create` permission.
|
|
6979
|
+
</dd>
|
|
6980
|
+
</dl>
|
|
6981
|
+
</dd>
|
|
6982
|
+
</dl>
|
|
6983
|
+
|
|
6984
|
+
#### 🔌 Usage
|
|
6985
|
+
|
|
6986
|
+
<dl>
|
|
6987
|
+
<dd>
|
|
6988
|
+
|
|
6989
|
+
<dl>
|
|
6990
|
+
<dd>
|
|
6991
|
+
|
|
6992
|
+
```typescript
|
|
6993
|
+
await client.management.verifyAccountDetails("entry752", {
|
|
6994
|
+
routingNumber: "122105278",
|
|
6995
|
+
accountNumber: "0000000016",
|
|
6996
|
+
accountType: "Checking",
|
|
6997
|
+
country: "US",
|
|
6998
|
+
accountHolderType: "personal",
|
|
6999
|
+
holderName: "Jane Doe"
|
|
7000
|
+
});
|
|
7001
|
+
|
|
7002
|
+
```
|
|
7003
|
+
</dd>
|
|
7004
|
+
</dl>
|
|
7005
|
+
</dd>
|
|
7006
|
+
</dl>
|
|
7007
|
+
|
|
7008
|
+
#### ⚙️ Parameters
|
|
7009
|
+
|
|
7010
|
+
<dl>
|
|
7011
|
+
<dd>
|
|
7012
|
+
|
|
7013
|
+
<dl>
|
|
7014
|
+
<dd>
|
|
7015
|
+
|
|
7016
|
+
**entry:** `string` — The paypoint's entry name identifier.
|
|
7017
|
+
|
|
7018
|
+
</dd>
|
|
7019
|
+
</dl>
|
|
7020
|
+
|
|
7021
|
+
<dl>
|
|
7022
|
+
<dd>
|
|
7023
|
+
|
|
7024
|
+
**request:** `Payabli.VerifyAccountDetailsRequest`
|
|
7025
|
+
|
|
7026
|
+
</dd>
|
|
7027
|
+
</dl>
|
|
7028
|
+
|
|
7029
|
+
<dl>
|
|
7030
|
+
<dd>
|
|
7031
|
+
|
|
7032
|
+
**requestOptions:** `ManagementClient.RequestOptions`
|
|
7033
|
+
|
|
7034
|
+
</dd>
|
|
7035
|
+
</dl>
|
|
7036
|
+
</dd>
|
|
7037
|
+
</dl>
|
|
7038
|
+
|
|
7039
|
+
|
|
6955
7040
|
</dd>
|
|
6956
7041
|
</dl>
|
|
6957
7042
|
</details>
|
|
@@ -7449,7 +7534,7 @@ await client.moneyIn.getpaid({
|
|
|
7449
7534
|
<dl>
|
|
7450
7535
|
<dd>
|
|
7451
7536
|
|
|
7452
|
-
A reversal either refunds or voids a transaction independent of the transaction's settlement status. Send a reversal request for a transaction, and Payabli automatically determines whether it's a refund or void. You don't need to know whether the transaction is settled or not.
|
|
7537
|
+
A reversal either refunds or voids a transaction independent of the transaction's settlement status. Send a reversal request for a transaction, and Payabli automatically determines whether it's a refund or void. You don't need to know whether the transaction is settled or not. This endpoint only works on transactions made with the v1 API. For v2 transactions, check the transaction's settlement status and call v2 void or v2 refund based on the result.
|
|
7453
7538
|
</dd>
|
|
7454
7539
|
</dl>
|
|
7455
7540
|
</dd>
|
|
@@ -8422,7 +8507,7 @@ await client.moneyIn.voidv2("10-3ffa27df-b171-44e0-b251-e95fbfc7a723");
|
|
|
8422
8507
|
<dl>
|
|
8423
8508
|
<dd>
|
|
8424
8509
|
|
|
8425
|
-
Authorizes transaction for payout.
|
|
8510
|
+
Authorizes transaction for payout. If you don't pass the `autoCapture` field with a value of `true`, authorized transactions aren't flagged for settlement until captured. Use `referenceId` returned in the response to capture the transaction.
|
|
8426
8511
|
</dd>
|
|
8427
8512
|
</dl>
|
|
8428
8513
|
</dd>
|
|
@@ -8440,6 +8525,7 @@ Authorizes transaction for payout. Authorized transactions aren't flagged for se
|
|
|
8440
8525
|
await client.moneyOut.authorizeOut({
|
|
8441
8526
|
body: {
|
|
8442
8527
|
entryPoint: "48acde49",
|
|
8528
|
+
autoCapture: true,
|
|
8443
8529
|
invoiceData: [{
|
|
8444
8530
|
billId: 54323
|
|
8445
8531
|
}],
|
|
@@ -8757,7 +8843,7 @@ await client.moneyOut.captureAllOut({
|
|
|
8757
8843
|
<dl>
|
|
8758
8844
|
<dd>
|
|
8759
8845
|
|
|
8760
|
-
Captures a single authorized payout transaction by ID.
|
|
8846
|
+
Captures a single authorized payout transaction by ID. If the transaction was authorized with `autoCapture` set to `true`, you don't need to call this endpoint to capture the transaction for processing.
|
|
8761
8847
|
</dd>
|
|
8762
8848
|
</dl>
|
|
8763
8849
|
</dd>
|
|
@@ -13648,6 +13734,156 @@ await client.query.listCustomersOrg(123, {
|
|
|
13648
13734
|
</dl>
|
|
13649
13735
|
|
|
13650
13736
|
|
|
13737
|
+
</dd>
|
|
13738
|
+
</dl>
|
|
13739
|
+
</details>
|
|
13740
|
+
|
|
13741
|
+
<details><summary><code>client.query.<a href="/src/api/resources/query/client/Client.ts">listDevices</a>(entry, { ...params }) -> Payabli.QueryDeviceResponse</code></summary>
|
|
13742
|
+
<dl>
|
|
13743
|
+
<dd>
|
|
13744
|
+
|
|
13745
|
+
#### 📝 Description
|
|
13746
|
+
|
|
13747
|
+
<dl>
|
|
13748
|
+
<dd>
|
|
13749
|
+
|
|
13750
|
+
<dl>
|
|
13751
|
+
<dd>
|
|
13752
|
+
|
|
13753
|
+
Returns a list of cloud devices for a single paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
|
|
13754
|
+
</dd>
|
|
13755
|
+
</dl>
|
|
13756
|
+
</dd>
|
|
13757
|
+
</dl>
|
|
13758
|
+
|
|
13759
|
+
#### 🔌 Usage
|
|
13760
|
+
|
|
13761
|
+
<dl>
|
|
13762
|
+
<dd>
|
|
13763
|
+
|
|
13764
|
+
<dl>
|
|
13765
|
+
<dd>
|
|
13766
|
+
|
|
13767
|
+
```typescript
|
|
13768
|
+
await client.query.listDevices("8cfec329267", {
|
|
13769
|
+
fromRecord: 0,
|
|
13770
|
+
limitRecord: 20,
|
|
13771
|
+
sortBy: "desc(createdAt)"
|
|
13772
|
+
});
|
|
13773
|
+
|
|
13774
|
+
```
|
|
13775
|
+
</dd>
|
|
13776
|
+
</dl>
|
|
13777
|
+
</dd>
|
|
13778
|
+
</dl>
|
|
13779
|
+
|
|
13780
|
+
#### ⚙️ Parameters
|
|
13781
|
+
|
|
13782
|
+
<dl>
|
|
13783
|
+
<dd>
|
|
13784
|
+
|
|
13785
|
+
<dl>
|
|
13786
|
+
<dd>
|
|
13787
|
+
|
|
13788
|
+
**entry:** `Payabli.Entry`
|
|
13789
|
+
|
|
13790
|
+
</dd>
|
|
13791
|
+
</dl>
|
|
13792
|
+
|
|
13793
|
+
<dl>
|
|
13794
|
+
<dd>
|
|
13795
|
+
|
|
13796
|
+
**request:** `Payabli.ListDevicesRequest`
|
|
13797
|
+
|
|
13798
|
+
</dd>
|
|
13799
|
+
</dl>
|
|
13800
|
+
|
|
13801
|
+
<dl>
|
|
13802
|
+
<dd>
|
|
13803
|
+
|
|
13804
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
13805
|
+
|
|
13806
|
+
</dd>
|
|
13807
|
+
</dl>
|
|
13808
|
+
</dd>
|
|
13809
|
+
</dl>
|
|
13810
|
+
|
|
13811
|
+
|
|
13812
|
+
</dd>
|
|
13813
|
+
</dl>
|
|
13814
|
+
</details>
|
|
13815
|
+
|
|
13816
|
+
<details><summary><code>client.query.<a href="/src/api/resources/query/client/Client.ts">listDevicesOrg</a>(orgId, { ...params }) -> Payabli.QueryDeviceResponse</code></summary>
|
|
13817
|
+
<dl>
|
|
13818
|
+
<dd>
|
|
13819
|
+
|
|
13820
|
+
#### 📝 Description
|
|
13821
|
+
|
|
13822
|
+
<dl>
|
|
13823
|
+
<dd>
|
|
13824
|
+
|
|
13825
|
+
<dl>
|
|
13826
|
+
<dd>
|
|
13827
|
+
|
|
13828
|
+
Returns a list of cloud devices for a single organization. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
|
|
13829
|
+
</dd>
|
|
13830
|
+
</dl>
|
|
13831
|
+
</dd>
|
|
13832
|
+
</dl>
|
|
13833
|
+
|
|
13834
|
+
#### 🔌 Usage
|
|
13835
|
+
|
|
13836
|
+
<dl>
|
|
13837
|
+
<dd>
|
|
13838
|
+
|
|
13839
|
+
<dl>
|
|
13840
|
+
<dd>
|
|
13841
|
+
|
|
13842
|
+
```typescript
|
|
13843
|
+
await client.query.listDevicesOrg(100, {
|
|
13844
|
+
fromRecord: 0,
|
|
13845
|
+
limitRecord: 20,
|
|
13846
|
+
sortBy: "desc(createdAt)"
|
|
13847
|
+
});
|
|
13848
|
+
|
|
13849
|
+
```
|
|
13850
|
+
</dd>
|
|
13851
|
+
</dl>
|
|
13852
|
+
</dd>
|
|
13853
|
+
</dl>
|
|
13854
|
+
|
|
13855
|
+
#### ⚙️ Parameters
|
|
13856
|
+
|
|
13857
|
+
<dl>
|
|
13858
|
+
<dd>
|
|
13859
|
+
|
|
13860
|
+
<dl>
|
|
13861
|
+
<dd>
|
|
13862
|
+
|
|
13863
|
+
**orgId:** `number` — The numeric identifier for organization, assigned by Payabli.
|
|
13864
|
+
|
|
13865
|
+
</dd>
|
|
13866
|
+
</dl>
|
|
13867
|
+
|
|
13868
|
+
<dl>
|
|
13869
|
+
<dd>
|
|
13870
|
+
|
|
13871
|
+
**request:** `Payabli.ListDevicesOrgRequest`
|
|
13872
|
+
|
|
13873
|
+
</dd>
|
|
13874
|
+
</dl>
|
|
13875
|
+
|
|
13876
|
+
<dl>
|
|
13877
|
+
<dd>
|
|
13878
|
+
|
|
13879
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
13880
|
+
|
|
13881
|
+
</dd>
|
|
13882
|
+
</dl>
|
|
13883
|
+
</dd>
|
|
13884
|
+
</dl>
|
|
13885
|
+
|
|
13886
|
+
|
|
13651
13887
|
</dd>
|
|
13652
13888
|
</dl>
|
|
13653
13889
|
</details>
|
|
@@ -18141,7 +18377,7 @@ await client.vendor.editVendor(1, {
|
|
|
18141
18377
|
<dl>
|
|
18142
18378
|
<dd>
|
|
18143
18379
|
|
|
18144
|
-
Retrieves a vendor's details.
|
|
18380
|
+
Retrieves a vendor's details, including enrichment status and payment acceptance info when available.
|
|
18145
18381
|
</dd>
|
|
18146
18382
|
</dl>
|
|
18147
18383
|
</dd>
|
|
@@ -18188,6 +18424,87 @@ await client.vendor.getVendor(1);
|
|
|
18188
18424
|
</dl>
|
|
18189
18425
|
|
|
18190
18426
|
|
|
18427
|
+
</dd>
|
|
18428
|
+
</dl>
|
|
18429
|
+
</details>
|
|
18430
|
+
|
|
18431
|
+
<details><summary><code>client.vendor.<a href="/src/api/resources/vendor/client/Client.ts">enrichVendor</a>(entry, { ...params }) -> Payabli.VendorEnrichResponse</code></summary>
|
|
18432
|
+
<dl>
|
|
18433
|
+
<dd>
|
|
18434
|
+
|
|
18435
|
+
#### 📝 Description
|
|
18436
|
+
|
|
18437
|
+
<dl>
|
|
18438
|
+
<dd>
|
|
18439
|
+
|
|
18440
|
+
<dl>
|
|
18441
|
+
<dd>
|
|
18442
|
+
|
|
18443
|
+
Triggers AI-powered vendor enrichment for an existing vendor. Runs one or more enrichment stages (invoice scan, web search) based on the `scope` parameter. Can automatically apply extracted payment acceptance info and vendor contact information to the vendor record, or return raw results for manual review. Contact Payabli to enable this feature.
|
|
18444
|
+
</dd>
|
|
18445
|
+
</dl>
|
|
18446
|
+
</dd>
|
|
18447
|
+
</dl>
|
|
18448
|
+
|
|
18449
|
+
#### 🔌 Usage
|
|
18450
|
+
|
|
18451
|
+
<dl>
|
|
18452
|
+
<dd>
|
|
18453
|
+
|
|
18454
|
+
<dl>
|
|
18455
|
+
<dd>
|
|
18456
|
+
|
|
18457
|
+
```typescript
|
|
18458
|
+
await client.vendor.enrichVendor("8cfec329267", {
|
|
18459
|
+
vendorId: 3890,
|
|
18460
|
+
scope: ["invoice_scan"],
|
|
18461
|
+
applyEnrichmentData: false,
|
|
18462
|
+
fallbackMethod: "check",
|
|
18463
|
+
invoiceFile: {
|
|
18464
|
+
ftype: "pdf",
|
|
18465
|
+
filename: "invoice-2026-001.pdf",
|
|
18466
|
+
fContent: "<base64-encoded-pdf>"
|
|
18467
|
+
}
|
|
18468
|
+
});
|
|
18469
|
+
|
|
18470
|
+
```
|
|
18471
|
+
</dd>
|
|
18472
|
+
</dl>
|
|
18473
|
+
</dd>
|
|
18474
|
+
</dl>
|
|
18475
|
+
|
|
18476
|
+
#### ⚙️ Parameters
|
|
18477
|
+
|
|
18478
|
+
<dl>
|
|
18479
|
+
<dd>
|
|
18480
|
+
|
|
18481
|
+
<dl>
|
|
18482
|
+
<dd>
|
|
18483
|
+
|
|
18484
|
+
**entry:** `string` — Entrypoint identifier.
|
|
18485
|
+
|
|
18486
|
+
</dd>
|
|
18487
|
+
</dl>
|
|
18488
|
+
|
|
18489
|
+
<dl>
|
|
18490
|
+
<dd>
|
|
18491
|
+
|
|
18492
|
+
**request:** `Payabli.VendorEnrichRequest`
|
|
18493
|
+
|
|
18494
|
+
</dd>
|
|
18495
|
+
</dl>
|
|
18496
|
+
|
|
18497
|
+
<dl>
|
|
18498
|
+
<dd>
|
|
18499
|
+
|
|
18500
|
+
**requestOptions:** `VendorClient.RequestOptions`
|
|
18501
|
+
|
|
18502
|
+
</dd>
|
|
18503
|
+
</dl>
|
|
18504
|
+
</dd>
|
|
18505
|
+
</dl>
|
|
18506
|
+
|
|
18507
|
+
|
|
18191
18508
|
</dd>
|
|
18192
18509
|
</dl>
|
|
18193
18510
|
</details>
|