payabli 2.2.26 → 2.2.29

data/reference.md

@@ -2046,6 +2046,136 @@ client.boarding.update_application(app_id: 352)
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.boarding.<a href="/lib/payabli/boarding/client.rb">add_service_to_paypoint_from_app</a>(request) -> Payabli::Boarding::Types::CreateApplicationFromPaypointResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Creates a new boarding application linked to an existing paypoint as part of the multi-product boarding flow. Use this endpoint to add new services to a paypoint without creating a duplicate record. The system copies eligible business, contact, banking, and address data from the paypoint to the new application based on 1:1 field matching. The merchant only needs to provide fields that are specific to the new service. See the [Multi-product boarding](/guides/pay-ops-developer-boarding-multi-product) guide for the full flow.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.boarding.add_service_to_paypoint_from_app(
+  paypoint_id: 123,
+  template_id: 456,
+  recipient_email: "merchant@example.com",
+  return_boarding_access_info_in_line: true,
+  on_create: ["submitApplication"]
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Payabli::Boarding::Types::CreateApplicationFromPaypointRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Payabli::Boarding::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.boarding.<a href="/lib/payabli/boarding/client.rb">get_applications_by_paypoint_id</a>(paypoint_id) -> Payabli::Types::QueryBoardingAppsListResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns all boarding applications associated with a specific paypoint, including those created through the multi-product boarding flow. Use this endpoint to track underwriting progress across multiple service additions or to build reporting views. See the [Multi-product boarding](/guides/pay-ops-developer-boarding-multi-product) guide for the full flow.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.boarding.get_applications_by_paypoint_id(paypoint_id: 12345)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**paypoint_id:** `Integer` — ID of the paypoint to retrieve applications for.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Payabli::Boarding::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -12123,7 +12253,11 @@ client.money_in.voidv_2(trans_id: "10-3ffa27df-b171-44e0-b251-e95fbfc7a723")
 <dl>
 <dd>
 
-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. 
+Authorizes a transaction for payout.
+
+If you don't pass `autoCapture` with a value of `true`, authorized transactions aren't flagged for settlement until captured. Use the `referenceId` returned in the response to capture the transaction.
+
+When `autoCapture` is `true`, Payabli captures the transaction asynchronously after authorization. The response confirms only that the transaction was authorized; it doesn't confirm that capture succeeded. To confirm capture, listen for the [`payout_transaction_approvedcaptured`](/developers/webhooks/payout-transaction-approved-captured) webhook event.
 </dd>
 </dl>
 </dd>
@@ -20964,6 +21098,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
 - `orgName` (ne, eq, ct, nct)
 - `externalPaypointId` (ct, nct, ne, eq)
 - `subId` (eq, ne)
+- `idPmethod` (eq, ne, ct, nct, in, nin). Filters by the subscription's linked stored method identifier (the value returned in `StoredMethod.IdPmethod`). Case-insensitive. Subscriptions without a linked stored method are excluded from matches. Example: `idPmethod(eq,6edcbb56-9c0e-4003-b3d1-99abf149ba0e)`.
 - `orderDescription` (ct, nct)
 - `cycles` (eq, ne, gt, ge, lt, le)
 - `leftcycles` (eq, ne, gt, ge, lt, le)
@@ -21148,6 +21283,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
 - `orgName` (ne, eq, ct, nct)
 - `externalPaypointId` (ct, nct, ne, eq)
 - `subId` (eq, ne)
+- `idPmethod` (eq, ne, ct, nct, in, nin). Filters by the subscription's linked stored method identifier (the value returned in `StoredMethod.IdPmethod`). Case-insensitive. Subscriptions without a linked stored method are excluded from matches. Example: `idPmethod(eq,6edcbb56-9c0e-4003-b3d1-99abf149ba0e)`.
 - `orderDescription` (ct, nct)
 - `cycles` (eq, ne, gt, ge, lt, le)
 - `leftcycles` (eq, ne, gt, ge, lt, le)
@@ -21651,6 +21787,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
 - `scheduleId` (ne, eq)
 - `returnId` (ne, eq)
 - `refundId` (ne, eq)
+- `rejectId` (ne, eq)
 - `idTrans` (ne, eq)
 - `orgId` (ne, eq)
 - `paypointId` (ne, eq)
@@ -21856,6 +21993,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
 - `scheduleId` (ne, eq)
 - `returnId` (ne, eq)
 - `refundId` (ne, eq)
+- `rejectId` (ne, eq)
 - `idTrans` (ne, eq)
 - `orgId` (ne, eq)
 - `paypointId` (ne, eq)
@@ -23152,6 +23290,7 @@ List of field names accepted:
 - `ein` (ct, nct, eq, ne)
 - `phone` (ct, nct, eq, ne)
 - `email` (ct, nct, eq, ne)
+- `remitEmail` (ct, nct, eq, ne)
 - `address` (ct, nct, eq, ne)
 - `city` (ct, nct, eq, ne)
 - `state` (ct, nct, eq, ne)
@@ -23314,6 +23453,7 @@ List of field names accepted:
 - `ein` (ct, nct, eq, ne)
 - `phone` (ct, nct, eq, ne)
 - `email` (ct, nct, eq, ne)
+- `remitEmail` (ct, nct, eq, ne)
 - `address` (ct, nct, eq, ne)
 - `city` (ct, nct, eq, ne)
 - `state` (ct, nct, eq, ne)
@@ -23467,36 +23607,344 @@ Collection of field names, conditions, and values used to filter the query.
 </Info>
 List of field names accepted:  
 
-  - `status` (in, nin, eq, ne)  
-  - `createdAt` (gt, ge, lt, le, eq, ne)  
-  - `cardToken` (ct, nct, eq, ne)  
-  - `lastFour` (ct, nct, eq, ne)  
-  - `expirationDate` (ct, nct, eq, ne)  
-  - `payoutId` (ct, nct, eq, ne, in, nin)  
-  - `vendorId` (ct, nct, eq, ne, in, nin)  
-  - `miscData1` (ct, nct, eq, ne)  
-  - `miscData2` (ct, nct, eq, ne)  
-  - `currentUses` (gt, ge, lt, le, eq, ne)  
-  - `amount` (gt, ge, lt, le, eq, ne)  
-  - `balance` (gt, ge, lt, le, eq, ne)  
-  - `paypointLegal` (ne, eq, ct, nct)  
-  - `paypointDba` (ne, eq, ct, nct)  
-  - `orgName` (ne, eq, ct, nct)  
-  - `externalPaypointId` (ct, nct, eq, ne)  
-  - `paypointId` (in, nin, eq, ne)  
-  - `cardType` (eq)  
+  - `status` (eq, ne, ct, nct, sw, ew)
+  - `createdAt` (gt, ge, lt, le, eq, ne)
+  - `cardToken` (ct, nct, eq, ne)
+  - `lastFour` (ct, nct, eq, ne)
+  - `expirationDate` (ct, nct, eq, ne)
+  - `payoutId` (eq, ne, gt, ge, lt, le)
+  - `vendorId` (eq, ne, gt, ge, lt, le)
+  - `miscData1` (ct, nct, eq, ne)
+  - `miscData2` (ct, nct, eq, ne)
+  - `currentUses` (gt, ge, lt, le, eq, ne)
+  - `amount` (gt, ge, lt, le, eq, ne)
+  - `balance` (gt, ge, lt, le, eq, ne)
+  - `paypointLegal` (ne, eq, ct, nct)
+  - `paypointDba` (ne, eq, ct, nct)
+  - `orgName` (eq, ne, ct, nct, sw, ew)
+  - `externalPaypointId` (ct, nct, eq, ne)
+  - `paypointId` (eq, ne, gt, ge, lt, le)
+  - `cardType` (eq, ne, gt, ge, lt, le)
 
 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 separated by "|"  
+  - 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
+  - sw => starts with
+  - ew => ends with
+  - in => inside array separated by "|"
+  - nin => not inside array separated by "|"
+    
+</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_vcards_transactions</a>(entry) -> Payabli::QueryTypes::Types::VCardTransactionQueryResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieve a list of virtual card transactions for an entrypoint. Use filters to limit results.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.query.list_vcards_transactions(
+  entry: "8cfec329267",
+  from_record: 0,
+  limit_record: 20,
+  sort_by: "desc(CreatedOn)"
+)
+```
+</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/vcardsTransactions/8cfec329267?parameters=transactionAmount(gt)=100&limitRecord=20
+
+  should become:
+
+  --url https://api-sandbox.payabli.com/api/Query/vcardsTransactions/8cfec329267?transactionAmount(gt)=100&limitRecord=20
+</Info>
+
+List of field names accepted:
+
+  - `identifier` (eq, ne, ct, nct)
+  - `transactionType` (eq, ne, ct, nct)
+  - `transactionStatus` (eq, ne, ct, nct, in, nin)
+  - `transactionAmount` (eq, ne, gt, ge, lt, le, ct, nct)
+  - `transactionCreatedOn` (eq, ne, gt, ge, lt, le)
+  - `cardToken` (ct, nct, eq, ne)
+  - `lastFour` (ct, nct, eq, ne)
+  - `expirationDate` (ct, nct, eq, ne)
+  - `mcc` (ct, nct, eq, ne)
+  - `payoutId` (gt, lt, eq, ne)
+  - `customerId` (gt, lt, eq, ne)
+  - `vendorId` (gt, lt, eq, ne)
+  - `miscData1` (ct, nct, eq, ne)
+  - `miscData2` (ct, nct, eq, ne)
+  - `currentUses` (gt, ge, lt, le, eq, ne)
+  - `amount` (gt, ge, lt, le, eq, ne)
+  - `balance` (gt, ge, lt, le, eq, ne)
+  - `paypointLegal` (ne, eq, ct, nct)
+  - `paypointDba` (ne, eq, ct, nct)
+  - `orgName` (ne, eq, ct, nct, in, nin)
+  - `externalPaypointID` (ct, nct, eq, ne)
+  - `paypointId` (gt, lt, 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 separated by "|"
+  - nin => not inside array separated by "|"
+    
+</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_vcards_transactions_org</a>(org_id) -> Payabli::QueryTypes::Types::VCardTransactionQueryResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieve a list of virtual card transactions for an organization. Use filters to limit results.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.query.list_vcards_transactions_org(
+  org_id: 123,
+  from_record: 0,
+  limit_record: 20,
+  sort_by: "desc(CreatedOn)"
+)
+```
+</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/vcardsTransactions/org/236?parameters=transactionAmount(gt)=100&limitRecord=20
+
+  should become:
+
+  --url https://api-sandbox.payabli.com/api/Query/vcardsTransactions/org/236?transactionAmount(gt)=100&limitRecord=20
+</Info>
+
+List of field names accepted:
+
+  - `identifier` (eq, ne, ct, nct)
+  - `transactionType` (eq, ne, ct, nct)
+  - `transactionStatus` (eq, ne, ct, nct, in, nin)
+  - `transactionAmount` (eq, ne, gt, ge, lt, le, ct, nct)
+  - `transactionCreatedOn` (eq, ne, gt, ge, lt, le)
+  - `cardToken` (ct, nct, eq, ne)
+  - `lastFour` (ct, nct, eq, ne)
+  - `expirationDate` (ct, nct, eq, ne)
+  - `mcc` (ct, nct, eq, ne)
+  - `payoutId` (gt, lt, eq, ne)
+  - `customerId` (gt, lt, eq, ne)
+  - `vendorId` (gt, lt, eq, ne)
+  - `miscData1` (ct, nct, eq, ne)
+  - `miscData2` (ct, nct, eq, ne)
+  - `currentUses` (gt, ge, lt, le, eq, ne)
+  - `amount` (gt, ge, lt, le, eq, ne)
+  - `balance` (gt, ge, lt, le, eq, ne)
+  - `paypointLegal` (ne, eq, ct, nct)
+  - `paypointDba` (ne, eq, ct, nct)
+  - `orgName` (ne, eq, ct, nct, in, nin)
+  - `externalPaypointID` (ct, nct, eq, ne)
+  - `paypointId` (gt, lt, 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 separated by "|"
   - nin => not inside array separated by "|"
     
 </dd>
@@ -23622,36 +24070,38 @@ Collection of field names, conditions, and values used to filter the query.
 </Info>
 List of field names accepted:  
 
-  - `status` (in, nin, eq, ne)  
-  - `createdAt` (gt, ge, lt, le, eq, ne)  
-  - `cardToken` (ct, nct, eq, ne)  
-  - `lastFour` (ct, nct, eq, ne)  
-  - `expirationDate` (ct, nct, eq, ne)  
-  - `payoutId` (ct, nct, eq, ne, in, nin)  
-  - `vendorId` (ct, nct, eq, ne, in, nin)  
-  - `miscData1` (ct, nct, eq, ne)  
-  - `miscData2` (ct, nct, eq, ne)  
-  - `currentUses` (gt, ge, lt, le, eq, ne)  
-  - `amount` (gt, ge, lt, le, eq, ne)  
-  - `balance` (gt, ge, lt, le, eq, ne)  
-  - `paypointLegal` (ne, eq, ct, nct)  
-  - `paypointDba` (ne, eq, ct, nct)  
-  - `orgName` (ne, eq, ct, nct)  
-  - `externalPaypointId` (ct, nct, eq, ne)  
-  - `paypointId` (in, nin, eq, ne)  
-  - `cardType` (eq)  
+  - `status` (eq, ne, ct, nct, sw, ew)
+  - `createdAt` (gt, ge, lt, le, eq, ne)
+  - `cardToken` (ct, nct, eq, ne)
+  - `lastFour` (ct, nct, eq, ne)
+  - `expirationDate` (ct, nct, eq, ne)
+  - `payoutId` (eq, ne, gt, ge, lt, le)
+  - `vendorId` (eq, ne, gt, ge, lt, le)
+  - `miscData1` (ct, nct, eq, ne)
+  - `miscData2` (ct, nct, eq, ne)
+  - `currentUses` (gt, ge, lt, le, eq, ne)
+  - `amount` (gt, ge, lt, le, eq, ne)
+  - `balance` (gt, ge, lt, le, eq, ne)
+  - `paypointLegal` (ne, eq, ct, nct)
+  - `paypointDba` (ne, eq, ct, nct)
+  - `orgName` (eq, ne, ct, nct, sw, ew)
+  - `externalPaypointId` (ct, nct, eq, ne)
+  - `paypointId` (eq, ne, gt, ge, lt, le)
+  - `cardType` (eq, ne, gt, ge, lt, le)
 
 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 separated by "|"  
+  - 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
+  - sw => starts with
+  - ew => ends with
+  - in => inside array separated by "|"
   - nin => not inside array separated by "|"
     
 </dd>