payabli 2.2.22 → 2.2.25

data/reference.md

@@ -2565,6 +2565,8 @@ client.cloud.history_device(
 <dl>
 <dd>
 
+Use [List devices by paypoint](/developers/api-reference/cloud/get-list-of-devices-for-a-paypoint) instead, which supports filters, sorting, and pagination.
+
 Get a list of cloud devices registered to an entrypoint.
 </dd>
 </dl>
@@ -10256,6 +10258,129 @@ client.line_item.update_item(
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## Management
+<details><summary><code>client.management.<a href="/lib/payabli/management/client.rb">verify_account_details</a>(entry, request) -> Payabli::Management::Types::VerifyAccountDetailsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+
+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.
+
+Requires `inboundpayments_create` or `outboundpayments_create` permission.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.management.verify_account_details(
+  entry: "entry752",
+  routing_number: "122105278",
+  account_number: "0000000016",
+  account_type: "Checking",
+  country: "US",
+  account_holder_type: "personal",
+  holder_name: "Jane Doe"
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**entry:** `String` — The paypoint's entry name identifier.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**routing_number:** `String` — The bank routing number to verify.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**account_number:** `String` — The bank account number to verify.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**account_type:** `String` — The type of bank account, such as `Checking` or `Savings`.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**country:** `String` — The ISO country code for the bank account, such as `US`.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**account_holder_type:** `String` — The type of account holder. Accepted values are `personal` or `business`. Required when bank authentication is enabled for the paypoint's organization.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**holder_name:** `String` — The name of the bank account holder. For personal accounts, provide the holder's full name (for example, `Jane Doe`); the value is split on the first space into first and last name. For business accounts, provide the legal business name. Required when bank authentication is enabled for the paypoint's organization.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Payabli::Management::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -10883,7 +11008,7 @@ client.money_in.getpaid(
 <dl>
 <dd>
 
-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.
+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.
 </dd>
 </dl>
 </dd>
@@ -11998,7 +12123,7 @@ client.money_in.voidv_2(trans_id: "10-3ffa27df-b171-44e0-b251-e95fbfc7a723")
 <dl>
 <dd>
 
-Authorizes transaction for payout. Authorized transactions aren't flagged for settlement until captured. Use `referenceId` returned in the response to capture the transaction. 
+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. 
 </dd>
 </dl>
 </dd>
@@ -12028,7 +12153,8 @@ client.money_out.authorize_out(
   },
   invoice_data: [{
     bill_id: 54323
-  }]
+  }],
+  auto_capture: true
 )
 ```
 </dd>
@@ -12364,7 +12490,7 @@ client.money_out.capture_all_out(body: %w[2-29 2-28 2-27])
 <dl>
 <dd>
 
-Captures a single authorized payout transaction by ID.
+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.
 </dd>
 </dl>
 </dd>
@@ -18678,7 +18804,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
 </dl>
 </details>
 
-<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_notification_reports</a>(entry) -> Payabli::Types::QueryResponseNotificationReports</code></summary>
+<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_devices</a>(entry) -> Payabli::QueryTypes::Types::QueryDeviceResponse</code></summary>
 <dl>
 <dd>
 
@@ -18690,7 +18816,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
 <dl>
 <dd>
 
-Returns a list of all reports generated in the last 60 days for a single entrypoint. Use filters to limit results.
+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.
 </dd>
 </dl>
 </dd>
@@ -18705,11 +18831,11 @@ Returns a list of all reports generated in the last 60 days for a single entrypo
 <dd>
 
 ```ruby
-client.query.list_notification_reports(
+client.query.list_devices(
   entry: "8cfec329267",
-  from_record: 251,
-  limit_record: 0,
-  sort_by: "desc(field_name)"
+  from_record: 0,
+  limit_record: 20,
+  sort_by: "desc(createdAt)"
 )
 ```
 </dd>
@@ -18733,6 +18859,14 @@ client.query.list_notification_reports(
 <dl>
 <dd>
 
+**export_format:** `Payabli::Types::ExportFormat` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **from_record:** `Integer` — The number of records to skip before starting to collect the result set.
     
 </dd>
@@ -18751,7 +18885,10 @@ client.query.list_notification_reports(
 
 **parameters:** `Internal::Types::Hash[String, String]` 
 
-Collection of field names, conditions, and values used to filter the query
+
+Collection of field names, conditions, and values used to filter
+the query.
+
 <Info>
   **You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
 
@@ -18759,36 +18896,88 @@ Collection of field names, conditions, and values used to filter the query
 
   For example:
 
-  --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
+  --url https://api-sandbox.payabli.com/api/Query/devices/8cfec329267?parameters=status=1&limitRecord=20
 
   should become:
 
-  --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
+  --url https://api-sandbox.payabli.com/api/Query/devices/8cfec329267?status=1&limitRecord=20
 </Info>
 
-See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
+See [Filters and Conditions
+Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
+for more information.
 
-List of field names accepted:
-- `reportName` (ct, nct, eq, ne)
-- `createdAt` (gt, ge, lt, le, eq, ne)
+**List of field names accepted:**
 
-List of comparison accepted - enclosed between parentheses:
-- eq or empty => equal
-- gt => greater than
-- ge => greater or equal
-- lt => less than
-- le => less or equal
-- ne => not equal
-- ct => contains
-- nct => not contains
-- in => inside array
-- nin => not inside array
 
-List of parameters accepted:
-- limitRecord : max number of records for query (default="20", "0" or negative value for all)
-- fromRecord : initial record in query
+- `deviceId` (eq, ne, ct, nct)
 
-Example: reportName(ct)=tr  return all records containing the string "tr"
+- `serialNumber` (eq, ne, ct, nct)
+
+- `friendlyName` (eq, ne, ct, nct)
+
+- `description` (eq, ne, ct, nct)
+
+- `model` (eq, ne, ct, nct)
+
+- `make` (eq, ne, ct, nct)
+
+- `macAddress` (eq, ne, ct, nct)
+
+- `registrationCode` (eq, ne, ct, nct)
+
+- `status` (eq, ne, in, nin)
+
+- `deviceType` (eq, ne, in, nin)
+
+- `deviceOs` (eq, ne, in, nin)
+
+- `activationAttempts` (eq, ne, gt, ge, lt, le)
+
+- `createdDate` (gt, ge, lt, le, eq, ne)
+
+- `updatedDate` (gt, ge, lt, le, eq, ne)
+
+- `lastHealthCheck` (gt, ge, lt, le, eq, ne)
+
+- `activationExpiry` (gt, ge, lt, le, eq, ne). This filter corresponds to the `activationCodeExpiry` response field.
+
+- `paypointId` (eq, ne)
+
+- `paypointDba` (eq, ne, ct, nct)
+
+- `paypointLegal` (eq, ne, ct, nct)
+
+- `paypointEntry` (eq, ne, ct, nct)
+
+- `externalPaypointId` (eq, ne, ct, nct)
+
+- `parentOrgId` (eq, ne)
+
+- `parentOrgName` (eq, ne, ct, nct)
+
+
+**List of comparison operators accepted:**
+
+- `eq` or empty => equal
+
+- `gt` => greater than
+
+- `ge` => greater or equal
+
+- `lt` => less than
+
+- `le` => less or equal
+
+- `ne` => not equal
+
+- `ct` => contains
+
+- `nct` => not contains
+
+- `in` => inside array
+
+- `nin` => not inside array
     
 </dd>
 </dl>
@@ -18816,7 +19005,7 @@ Example: reportName(ct)=tr  return all records containing the string "tr"
 </dl>
 </details>
 
-<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_notification_reports_org</a>(org_id) -> Payabli::Types::QueryResponseNotificationReports</code></summary>
+<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_devices_org</a>(org_id) -> Payabli::QueryTypes::Types::QueryDeviceResponse</code></summary>
 <dl>
 <dd>
 
@@ -18828,7 +19017,7 @@ Example: reportName(ct)=tr  return all records containing the string "tr"
 <dl>
 <dd>
 
-Returns a list of all reports generated in the last 60 days for an organization. Use filters to limit results.
+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.
 </dd>
 </dl>
 </dd>
@@ -18843,11 +19032,11 @@ Returns a list of all reports generated in the last 60 days for an organization.
 <dd>
 
 ```ruby
-client.query.list_notification_reports_org(
-  org_id: 123,
-  from_record: 251,
-  limit_record: 0,
-  sort_by: "desc(field_name)"
+client.query.list_devices_org(
+  org_id: 100,
+  from_record: 0,
+  limit_record: 20,
+  sort_by: "desc(createdAt)"
 )
 ```
 </dd>
@@ -18871,6 +19060,14 @@ client.query.list_notification_reports_org(
 <dl>
 <dd>
 
+**export_format:** `Payabli::Types::ExportFormat` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **from_record:** `Integer` — The number of records to skip before starting to collect the result set.
     
 </dd>
@@ -18889,59 +19086,390 @@ client.query.list_notification_reports_org(
 
 **parameters:** `Internal::Types::Hash[String, String]` 
 
-Collection of field names, conditions, and values used to filter the query <Info>
+
+Collection of field names, conditions, and values used to filter
+the query.
+
+<Info>
   **You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
 
   Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client.
 
   For example:
 
-  --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
+  --url https://api-sandbox.payabli.com/api/Query/devices/org/236?parameters=status=1&limitRecord=20
 
   should become:
 
-  --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
+  --url https://api-sandbox.payabli.com/api/Query/devices/org/236?status=1&limitRecord=20
 </Info>
-See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
 
-List of field names accepted:
-- `reportName` (ct, nct, eq, ne)
-- `createdAt` (gt, ge, lt, le, eq, ne)
+See [Filters and Conditions
+Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
+for more information.
 
-List of comparison accepted - enclosed between parentheses:
-- eq or empty => equal
-- gt => greater than
-- ge => greater or equal
-- lt => less than
-- le => less or equal
-- ne => not equal
-- ct => contains
-- nct => not contains
-- in => inside array
-- nin => not inside array
+**List of field names accepted:**
 
-List of parameters accepted:
-- limitRecord : max number of records for query (default="20", "0" or negative value for all)
-- fromRecord : initial record in query
 
-Example: reportName(ct)=tr  return all records containing the string "tr"
-    
-</dd>
-</dl>
+- `deviceId` (eq, ne, ct, nct)
 
-<dl>
-<dd>
+- `serialNumber` (eq, ne, ct, nct)
 
-**sort_by:** `String` — The field name to use for sorting results. Use `desc(field_name)` to sort descending by `field_name`, and use `asc(field_name)` to sort ascending by `field_name`.
-    
-</dd>
-</dl>
+- `friendlyName` (eq, ne, ct, nct)
 
-<dl>
-<dd>
+- `description` (eq, ne, ct, nct)
 
-**request_options:** `Payabli::Query::RequestOptions` 
-    
+- `model` (eq, ne, ct, nct)
+
+- `make` (eq, ne, ct, nct)
+
+- `macAddress` (eq, ne, ct, nct)
+
+- `registrationCode` (eq, ne, ct, nct)
+
+- `status` (eq, ne, in, nin)
+
+- `deviceType` (eq, ne, in, nin)
+
+- `deviceOs` (eq, ne, in, nin)
+
+- `activationAttempts` (eq, ne, gt, ge, lt, le)
+
+- `createdDate` (gt, ge, lt, le, eq, ne)
+
+- `updatedDate` (gt, ge, lt, le, eq, ne)
+
+- `lastHealthCheck` (gt, ge, lt, le, eq, ne)
+
+- `activationExpiry` (gt, ge, lt, le, eq, ne). This filter corresponds to the `activationCodeExpiry` response field.
+
+- `paypointId` (eq, ne)
+
+- `paypointDba` (eq, ne, ct, nct)
+
+- `paypointLegal` (eq, ne, ct, nct)
+
+- `paypointEntry` (eq, ne, ct, nct)
+
+- `externalPaypointId` (eq, ne, ct, nct)
+
+- `parentOrgId` (eq, ne)
+
+- `parentOrgName` (eq, ne, ct, nct)
+
+
+**List of comparison operators accepted:**
+
+- `eq` or empty => equal
+
+- `gt` => greater than
+
+- `ge` => greater or equal
+
+- `lt` => less than
+
+- `le` => less or equal
+
+- `ne` => not equal
+
+- `ct` => contains
+
+- `nct` => not contains
+
+- `in` => inside array
+
+- `nin` => not inside array
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**sort_by:** `String` — The field name to use for sorting results. Use `desc(field_name)` to sort descending by `field_name`, and use `asc(field_name)` to sort ascending by `field_name`.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Payabli::Query::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_notification_reports</a>(entry) -> Payabli::Types::QueryResponseNotificationReports</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns a list of all reports generated in the last 60 days for a single entrypoint. Use filters to limit results.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.query.list_notification_reports(
+  entry: "8cfec329267",
+  from_record: 251,
+  limit_record: 0,
+  sort_by: "desc(field_name)"
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**entry:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**from_record:** `Integer` — The number of records to skip before starting to collect the result set.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**limit_record:** `Integer` — Max number of records to return for the query. Use `0` or negative value to return all records.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**parameters:** `Internal::Types::Hash[String, String]` 
+
+Collection of field names, conditions, and values used to filter the query
+<Info>
+  **You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
+
+  Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client.
+
+  For example:
+
+  --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
+
+  should become:
+
+  --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
+</Info>
+
+See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
+
+List of field names accepted:
+- `reportName` (ct, nct, eq, ne)
+- `createdAt` (gt, ge, lt, le, eq, ne)
+
+List of comparison accepted - enclosed between parentheses:
+- eq or empty => equal
+- gt => greater than
+- ge => greater or equal
+- lt => less than
+- le => less or equal
+- ne => not equal
+- ct => contains
+- nct => not contains
+- in => inside array
+- nin => not inside array
+
+List of parameters accepted:
+- limitRecord : max number of records for query (default="20", "0" or negative value for all)
+- fromRecord : initial record in query
+
+Example: reportName(ct)=tr  return all records containing the string "tr"
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**sort_by:** `String` — The field name to use for sorting results. Use `desc(field_name)` to sort descending by `field_name`, and use `asc(field_name)` to sort ascending by `field_name`.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Payabli::Query::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_notification_reports_org</a>(org_id) -> Payabli::Types::QueryResponseNotificationReports</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns a list of all reports generated in the last 60 days for an organization. Use filters to limit results.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.query.list_notification_reports_org(
+  org_id: 123,
+  from_record: 251,
+  limit_record: 0,
+  sort_by: "desc(field_name)"
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**org_id:** `Integer` — The numeric identifier for organization, assigned by Payabli.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**from_record:** `Integer` — The number of records to skip before starting to collect the result set.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**limit_record:** `Integer` — Max number of records to return for the query. Use `0` or negative value to return all records.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**parameters:** `Internal::Types::Hash[String, String]` 
+
+Collection of field names, conditions, and values used to filter the query <Info>
+  **You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
+
+  Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client.
+
+  For example:
+
+  --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
+
+  should become:
+
+  --url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
+</Info>
+See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
+
+List of field names accepted:
+- `reportName` (ct, nct, eq, ne)
+- `createdAt` (gt, ge, lt, le, eq, ne)
+
+List of comparison accepted - enclosed between parentheses:
+- eq or empty => equal
+- gt => greater than
+- ge => greater or equal
+- lt => less than
+- le => less or equal
+- ne => not equal
+- ct => contains
+- nct => not contains
+- in => inside array
+- nin => not inside array
+
+List of parameters accepted:
+- limitRecord : max number of records for query (default="20", "0" or negative value for all)
+- fromRecord : initial record in query
+
+Example: reportName(ct)=tr  return all records containing the string "tr"
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**sort_by:** `String` — The field name to use for sorting results. Use `desc(field_name)` to sort descending by `field_name`, and use `asc(field_name)` to sort ascending by `field_name`.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Payabli::Query::RequestOptions` 
+    
 </dd>
 </dl>
 </dd>
@@ -22956,6 +23484,7 @@ List of field names accepted:
   - `orgName` (ne, eq, ct, nct)  
   - `externalPaypointId` (ct, nct, eq, ne)  
   - `paypointId` (in, nin, eq, ne)  
+  - `cardType` (eq)  
 
 List of comparison accepted - enclosed between parentheses:  
 
@@ -23110,6 +23639,7 @@ List of field names accepted:
   - `orgName` (ne, eq, ct, nct)  
   - `externalPaypointId` (ct, nct, eq, ne)  
   - `paypointId` (in, nin, eq, ne)  
+  - `cardType` (eq)  
 
 List of comparison accepted - enclosed between parentheses:  
 
@@ -25782,7 +26312,7 @@ client.vendor.edit_vendor(
 <dl>
 <dd>
 
-Retrieves a vendor's details.
+Retrieves a vendor's details, including enrichment status and payment acceptance info when available.
 </dd>
 </dl>
 </dd>
@@ -25828,6 +26358,87 @@ client.vendor.get_vendor(id_vendor: 1)
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.vendor.<a href="/lib/payabli/vendor/client.rb">enrich_vendor</a>(entry, request) -> Payabli::Vendor::Types::VendorEnrichResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.vendor.enrich_vendor(
+  entry: "8cfec329267",
+  vendor_id: 3890,
+  scope: ["invoice_scan"],
+  apply_enrichment_data: false,
+  invoice_file: {
+    ftype: "pdf",
+    filename: "invoice-2026-001.pdf",
+    f_content: "<base64-encoded-pdf>"
+  },
+  fallback_method: "check"
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**entry:** `String` — Entrypoint identifier.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Payabli::Vendor::Types::VendorEnrichRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Payabli::Vendor::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>