@payabli/sdk-node 0.0.140 → 0.0.141
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/api/resources/bill/types/BillOutData.d.ts +5 -1
- package/dist/cjs/api/resources/index.d.ts +1 -0
- package/dist/cjs/api/resources/index.js +1 -0
- 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/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/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/VendorData.d.ts +12 -0
- package/dist/cjs/api/types/VendorQueryRecord.d.ts +21 -0
- package/dist/cjs/api/types/index.d.ts +1 -0
- package/dist/cjs/api/types/index.js +1 -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/api/resources/bill/types/BillOutData.d.mts +5 -1
- package/dist/esm/api/resources/index.d.mts +1 -0
- package/dist/esm/api/resources/index.mjs +1 -0
- 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/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/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/VendorData.d.mts +12 -0
- package/dist/esm/api/types/VendorQueryRecord.d.mts +21 -0
- package/dist/esm/api/types/index.d.mts +1 -0
- package/dist/esm/api/types/index.mjs +1 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +85 -3
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
export * from "./VendorEnrichmentData.mjs";
|
|
2
|
+
export * from "./VendorEnrichmentInvoiceScan.mjs";
|
|
3
|
+
export * from "./VendorEnrichmentWebSearch.mjs";
|
|
4
|
+
export * from "./VendorEnrichRequest.mjs";
|
|
5
|
+
export * from "./VendorEnrichResponse.mjs";
|
|
6
|
+
export * from "./VendorEnrichResponseData.mjs";
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
export * from "./VendorEnrichmentData.mjs";
|
|
2
|
+
export * from "./VendorEnrichmentInvoiceScan.mjs";
|
|
3
|
+
export * from "./VendorEnrichmentWebSearch.mjs";
|
|
4
|
+
export * from "./VendorEnrichRequest.mjs";
|
|
5
|
+
export * from "./VendorEnrichResponse.mjs";
|
|
6
|
+
export * from "./VendorEnrichResponseData.mjs";
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* When `true`, the transaction is automatically captured after a successful authorization. When `false`, you must manually capture the transaction after a successful authorization. Defaults to `false`. See [Manage payouts with the API](/guides/pay-out-developer-payouts-manage) for more information.
|
|
3
|
+
*/
|
|
4
|
+
export type AutoCapture = boolean;
|
|
@@ -49,7 +49,6 @@ export declare namespace NotificationContent {
|
|
|
49
49
|
readonly ApprovedApplication: "ApprovedApplication";
|
|
50
50
|
readonly FailedBoardingApplication: "FailedBoardingApplication";
|
|
51
51
|
readonly SubmittedApplication: "SubmittedApplication";
|
|
52
|
-
readonly UnderWritingApplication: "UnderWritingApplication";
|
|
53
52
|
readonly ActivatedMerchant: "ActivatedMerchant";
|
|
54
53
|
readonly ReceivedChargeBack: "ReceivedChargeBack";
|
|
55
54
|
readonly ChargebackUpdated: "ChargebackUpdated";
|
|
@@ -32,7 +32,6 @@ export var NotificationContent;
|
|
|
32
32
|
ApprovedApplication: "ApprovedApplication",
|
|
33
33
|
FailedBoardingApplication: "FailedBoardingApplication",
|
|
34
34
|
SubmittedApplication: "SubmittedApplication",
|
|
35
|
-
UnderWritingApplication: "UnderWritingApplication",
|
|
36
35
|
ActivatedMerchant: "ActivatedMerchant",
|
|
37
36
|
ReceivedChargeBack: "ReceivedChargeBack",
|
|
38
37
|
ChargebackUpdated: "ChargebackUpdated",
|
|
@@ -108,7 +108,6 @@ export declare namespace NotificationStandardRequest {
|
|
|
108
108
|
readonly ApprovedApplication: "ApprovedApplication";
|
|
109
109
|
readonly FailedBoardingApplication: "FailedBoardingApplication";
|
|
110
110
|
readonly SubmittedApplication: "SubmittedApplication";
|
|
111
|
-
readonly UnderWritingApplication: "UnderWritingApplication";
|
|
112
111
|
readonly ActivatedMerchant: "ActivatedMerchant";
|
|
113
112
|
readonly ReceivedChargeBack: "ReceivedChargeBack";
|
|
114
113
|
readonly ChargebackUpdated: "ChargebackUpdated";
|
|
@@ -80,7 +80,6 @@ export var NotificationStandardRequest;
|
|
|
80
80
|
ApprovedApplication: "ApprovedApplication",
|
|
81
81
|
FailedBoardingApplication: "FailedBoardingApplication",
|
|
82
82
|
SubmittedApplication: "SubmittedApplication",
|
|
83
|
-
UnderWritingApplication: "UnderWritingApplication",
|
|
84
83
|
ActivatedMerchant: "ActivatedMerchant",
|
|
85
84
|
ReceivedChargeBack: "ReceivedChargeBack",
|
|
86
85
|
ChargebackUpdated: "ChargebackUpdated",
|
|
@@ -45,4 +45,16 @@ export interface VendorData {
|
|
|
45
45
|
vendorStatus?: Payabli.Vendorstatus | undefined;
|
|
46
46
|
/** Vendor's ZIP or postal code. Required if any address field is provided. For US addresses, use five digits (`12345`) or ZIP+4 format (`12345-6789`). */
|
|
47
47
|
zip?: string | undefined;
|
|
48
|
+
/** Identifier for the vendor's default stored payment method. */
|
|
49
|
+
defaultMethodId?: string | undefined;
|
|
50
|
+
/**
|
|
51
|
+
* PDF invoice attachment for AI-powered vendor enrichment.
|
|
52
|
+
* When this feature is enabled and you include an attachment, the invoice is scanned and extracted vendor information is merged into the request.
|
|
53
|
+
* Fields in the request body take precedence over extracted data.
|
|
54
|
+
* If the scan fails, vendor creation proceeds with the original request data.
|
|
55
|
+
*
|
|
56
|
+
* See the [vendor enrichment guide](/guides/pay-out-vendor-enrichment-overview) for details.
|
|
57
|
+
* Contact Payabli to enable this feature.
|
|
58
|
+
*/
|
|
59
|
+
attachment?: Payabli.FileContent | undefined;
|
|
48
60
|
}
|
|
@@ -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";
|
|
@@ -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";
|
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.141";
|
package/dist/esm/version.mjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const SDK_VERSION = "0.0.
|
|
1
|
+
export const SDK_VERSION = "0.0.141";
|
package/package.json
CHANGED
package/reference.md
CHANGED
|
@@ -8422,7 +8422,7 @@ await client.moneyIn.voidv2("10-3ffa27df-b171-44e0-b251-e95fbfc7a723");
|
|
|
8422
8422
|
<dl>
|
|
8423
8423
|
<dd>
|
|
8424
8424
|
|
|
8425
|
-
Authorizes transaction for payout.
|
|
8425
|
+
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
8426
|
</dd>
|
|
8427
8427
|
</dl>
|
|
8428
8428
|
</dd>
|
|
@@ -8440,6 +8440,7 @@ Authorizes transaction for payout. Authorized transactions aren't flagged for se
|
|
|
8440
8440
|
await client.moneyOut.authorizeOut({
|
|
8441
8441
|
body: {
|
|
8442
8442
|
entryPoint: "48acde49",
|
|
8443
|
+
autoCapture: true,
|
|
8443
8444
|
invoiceData: [{
|
|
8444
8445
|
billId: 54323
|
|
8445
8446
|
}],
|
|
@@ -8757,7 +8758,7 @@ await client.moneyOut.captureAllOut({
|
|
|
8757
8758
|
<dl>
|
|
8758
8759
|
<dd>
|
|
8759
8760
|
|
|
8760
|
-
Captures a single authorized payout transaction by ID.
|
|
8761
|
+
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
8762
|
</dd>
|
|
8762
8763
|
</dl>
|
|
8763
8764
|
</dd>
|
|
@@ -18141,7 +18142,7 @@ await client.vendor.editVendor(1, {
|
|
|
18141
18142
|
<dl>
|
|
18142
18143
|
<dd>
|
|
18143
18144
|
|
|
18144
|
-
Retrieves a vendor's details.
|
|
18145
|
+
Retrieves a vendor's details, including enrichment status and payment acceptance info when available.
|
|
18145
18146
|
</dd>
|
|
18146
18147
|
</dl>
|
|
18147
18148
|
</dd>
|
|
@@ -18188,6 +18189,87 @@ await client.vendor.getVendor(1);
|
|
|
18188
18189
|
</dl>
|
|
18189
18190
|
|
|
18190
18191
|
|
|
18192
|
+
</dd>
|
|
18193
|
+
</dl>
|
|
18194
|
+
</details>
|
|
18195
|
+
|
|
18196
|
+
<details><summary><code>client.vendor.<a href="/src/api/resources/vendor/client/Client.ts">enrichVendor</a>(entry, { ...params }) -> Payabli.VendorEnrichResponse</code></summary>
|
|
18197
|
+
<dl>
|
|
18198
|
+
<dd>
|
|
18199
|
+
|
|
18200
|
+
#### 📝 Description
|
|
18201
|
+
|
|
18202
|
+
<dl>
|
|
18203
|
+
<dd>
|
|
18204
|
+
|
|
18205
|
+
<dl>
|
|
18206
|
+
<dd>
|
|
18207
|
+
|
|
18208
|
+
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.
|
|
18209
|
+
</dd>
|
|
18210
|
+
</dl>
|
|
18211
|
+
</dd>
|
|
18212
|
+
</dl>
|
|
18213
|
+
|
|
18214
|
+
#### 🔌 Usage
|
|
18215
|
+
|
|
18216
|
+
<dl>
|
|
18217
|
+
<dd>
|
|
18218
|
+
|
|
18219
|
+
<dl>
|
|
18220
|
+
<dd>
|
|
18221
|
+
|
|
18222
|
+
```typescript
|
|
18223
|
+
await client.vendor.enrichVendor("8cfec329267", {
|
|
18224
|
+
vendorId: 3890,
|
|
18225
|
+
scope: ["invoice_scan"],
|
|
18226
|
+
applyEnrichmentData: false,
|
|
18227
|
+
fallbackMethod: "check",
|
|
18228
|
+
invoiceFile: {
|
|
18229
|
+
ftype: "pdf",
|
|
18230
|
+
filename: "invoice-2026-001.pdf",
|
|
18231
|
+
fContent: "<base64-encoded-pdf>"
|
|
18232
|
+
}
|
|
18233
|
+
});
|
|
18234
|
+
|
|
18235
|
+
```
|
|
18236
|
+
</dd>
|
|
18237
|
+
</dl>
|
|
18238
|
+
</dd>
|
|
18239
|
+
</dl>
|
|
18240
|
+
|
|
18241
|
+
#### ⚙️ Parameters
|
|
18242
|
+
|
|
18243
|
+
<dl>
|
|
18244
|
+
<dd>
|
|
18245
|
+
|
|
18246
|
+
<dl>
|
|
18247
|
+
<dd>
|
|
18248
|
+
|
|
18249
|
+
**entry:** `string` — Entrypoint identifier.
|
|
18250
|
+
|
|
18251
|
+
</dd>
|
|
18252
|
+
</dl>
|
|
18253
|
+
|
|
18254
|
+
<dl>
|
|
18255
|
+
<dd>
|
|
18256
|
+
|
|
18257
|
+
**request:** `Payabli.VendorEnrichRequest`
|
|
18258
|
+
|
|
18259
|
+
</dd>
|
|
18260
|
+
</dl>
|
|
18261
|
+
|
|
18262
|
+
<dl>
|
|
18263
|
+
<dd>
|
|
18264
|
+
|
|
18265
|
+
**requestOptions:** `VendorClient.RequestOptions`
|
|
18266
|
+
|
|
18267
|
+
</dd>
|
|
18268
|
+
</dl>
|
|
18269
|
+
</dd>
|
|
18270
|
+
</dl>
|
|
18271
|
+
|
|
18272
|
+
|
|
18191
18273
|
</dd>
|
|
18192
18274
|
</dl>
|
|
18193
18275
|
</details>
|