payabli 3.0.10 → 3.0.11

data/reference.md

@@ -9090,10 +9090,13 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
 - `chargebackDate` (gt, ge, lt, le, eq, ne)
 - `transId`  (ne, eq, ct, nct)
 - `method`   (in, nin, eq, ne)
+- `amount`  (gt, ge, lt, le, eq, ne): the chargeback or return's own amount (the top-level `netAmount` in the response), unlike `netAmount`, which matches the original transaction's net
+- `totalAmount`  (gt, ge, lt, le, eq, ne): the original transaction's gross amount, including service and pending fees (`transaction.totalAmount` in the response)
 - `netAmount`  (gt, ge, lt, le, eq, ne)
 - `reasonCode`   (in, nin, eq, ne)
 - `reason`  (ct, nct, eq, ne)
 - `replyDate` (gt, ge, lt, le, eq, ne)
+- `replyBy` (gt, ge, lt, le, eq, ne): alias of `replyDate`, matching the `replyBy` field in the response
 - `caseNumber`  (ct, nct, eq, ne)
 - `status`   (in, nin, eq, ne)
 - `accountType`   (in, nin, eq, ne)
@@ -9148,7 +9151,7 @@ Example: `netAmount(gt)=20` returns all records with a `netAmount` greater than
 <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`.
+**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`. For this endpoint, you can also sort by `amount` and `totalAmount`.
     
 </dd>
 </dl>
@@ -9268,10 +9271,13 @@ Collection of field names, conditions, and values used to filter the query.
 - `chargebackDate` (gt, ge, lt, le, eq, ne)
 - `transId`  (ne, eq, ct, nct)
 - `method`   (in, nin, eq, ne)
+- `amount`  (gt, ge, lt, le, eq, ne): the chargeback or return's own amount (the top-level `netAmount` in the response), unlike `netAmount`, which matches the original transaction's net
+- `totalAmount`  (gt, ge, lt, le, eq, ne): the original transaction's gross amount, including service and pending fees (`transaction.totalAmount` in the response)
 - `netAmount`  (gt, ge, lt, le, eq, ne)
 - `reasonCode`   (in, nin, eq, ne)
 - `reason`  (ct, nct, eq, ne)
 - `replyDate` (gt, ge, lt, le, eq, ne)
+- `replyBy` (gt, ge, lt, le, eq, ne): alias of `replyDate`, matching the `replyBy` field in the response
 - `caseNumber`  (ct, nct, eq, ne)
 - `status`   (in, nin, eq, ne)
 - `accountType`   (in, nin, eq, ne)
@@ -9327,7 +9333,7 @@ Example: `netAmount(gt)=20` returns all records with a `netAmount` greater than
 <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`.
+**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`. For this endpoint, you can also sort by `amount` and `totalAmount`.
     
 </dd>
 </dl>
@@ -10908,6 +10914,7 @@ Accepted field names:
   - `vendorName` (ct, nct, eq, ne)
   - `paymentMethod` (ct, nct, eq, ne, in, nin)
   - `paymentId` (ct, nct, eq, ne)
+  - `orderId` (ne, eq)
   - `parentOrgId` (ne, eq, nin, in)
   - `batchNumber` (ct, nct, eq, ne)
   - `totalAmount` (gt, ge, lt, le, eq, ne)
@@ -11093,6 +11100,7 @@ Accepted field names:
   - `parentOrgId` (ne, eq, nin, in)
   - `paymentMethod` (ct, nct, eq, ne, in, nin)
   - `paymentId` (ct, nct, eq, ne)
+  - `orderId` (ne, eq)
   - `batchNumber` (ct, nct, eq, ne)
   - `totalAmount` (gt, ge, lt, le, eq, ne)
   - `paypointLegal` (ne, eq, ct, nct)
@@ -14852,7 +14860,7 @@ Accepted comparison operators - enclosed between parentheses:
 <dl>
 <dd>
 
-Use this endpoint to upload an image file for OCR processing. The accepted file formats include PDF, JPG, JPEG, PNG, and GIF. Specify the desired type of result (either 'bill' or 'invoice') in the path parameter `typeResult`. The response will contain the OCR processing results, including extracted data such as bill number, vendor information, bill items, and more.
+Use this endpoint to upload a document file for OCR processing as `multipart/form-data`, with the file in a field named `file`. The accepted file formats include PDF, JPG, JPEG, PNG, and GIF. Specify the desired type of result (either 'bill' or 'invoice') in the path parameter `typeResult`. The response will contain the OCR processing results, including extracted data such as bill number, vendor information, bill items, and more. To send the file as a Base64-encoded string in a JSON body instead, use `ocrDocumentJson`.
 </dd>
 </dl>
 </dd>
@@ -14890,14 +14898,6 @@ client.ocr.ocr_document_form(type_result: "typeResult")
 <dl>
 <dd>
 
-**request:** `Payabli::Types::FileContentImageOnly` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
 **request_options:** `Payabli::Ocr::RequestOptions` 
     
 </dd>
@@ -14960,7 +14960,31 @@ client.ocr.ocr_document_json(type_result: "typeResult")
 <dl>
 <dd>
 
-**request:** `Payabli::Types::FileContentImageOnly` 
+**ftype:** `Payabli::Types::FileContentFtype` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**filename:** `String` — The name of the file to be uploaded
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**furl:** `String` — Optional URL link to the file
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**f_content:** `String` — Base64-encoded file content
     
 </dd>
 </dl>
@@ -26215,7 +26239,7 @@ Same-day ACH has a daily cutoff. Capture the transaction before the cutoff, or p
 <dl>
 <dd>
 
-**entry_point:** `String` 
+**request:** `Payabli::Types::AuthorizePayoutBody` 
     
 </dd>
 </dl>
@@ -26223,87 +26247,61 @@ Same-day ACH has a daily cutoff. Capture the transaction before the cutoff, or p
 <dl>
 <dd>
 
-**source:** `String` 
+**request_options:** `Payabli::MoneyOut::RequestOptions` 
     
 </dd>
 </dl>
-
-<dl>
-<dd>
-
-**order_id:** `String` 
-    
 </dd>
 </dl>
 
-<dl>
-<dd>
 
-**order_description:** `String` 
-    
 </dd>
 </dl>
+</details>
 
+<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">cancel_all_out</a>(request) -> Payabli::Types::CaptureAllOutResponse</code></summary>
 <dl>
 <dd>
 
-**payment_method:** `Payabli::Types::AuthorizePaymentMethod` 
-    
-</dd>
-</dl>
+#### 📝 Description
 
 <dl>
 <dd>
 
-**payment_details:** `Payabli::Types::RequestOutAuthorizePaymentDetails` — Object containing payment details.
-    
-</dd>
-</dl>
-
 <dl>
 <dd>
 
-**vendor_data:** `Payabli::Types::RequestOutAuthorizeVendorData` — Object containing vendor data.
-    
+Cancels an array of payout transactions.
 </dd>
 </dl>
-
-<dl>
-<dd>
-
-**invoice_data:** `Internal::Types::Array[Payabli::Types::RequestOutAuthorizeInvoiceData]` — Bills to pay with this payout, each referenced by `billId`.
-    
 </dd>
 </dl>
 
+#### 🔌 Usage
+
 <dl>
 <dd>
 
-**account_id:** `String` 
-    
-</dd>
-</dl>
-
 <dl>
 <dd>
 
-**subdomain:** `String` 
-    
+```ruby
+client.money_out.cancel_all_out(request: %w[2-29 2-28 2-27])
+```
+</dd>
+</dl>
 </dd>
 </dl>
 
+#### ⚙️ Parameters
+
 <dl>
 <dd>
 
-**subscription_id:** `Integer` 
-    
-</dd>
-</dl>
-
 <dl>
 <dd>
 
-**auto_capture:** `Internal::Types::Boolean` 
+**request:** `Internal::Types::Array[String]` 
     
 </dd>
 </dl>
@@ -26323,7 +26321,7 @@ Same-day ACH has a daily cutoff. Capture the transaction before the cutoff, or p
 </dl>
 </details>
 
-<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">cancel_all_out</a>(request) -> Payabli::Types::CaptureAllOutResponse</code></summary>
+<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">cancel_out_get</a>(reference_id:) -> Payabli::Types::PayabliApiResponse0000</code></summary>
 <dl>
 <dd>
 
@@ -26335,7 +26333,7 @@ Same-day ACH has a daily cutoff. Capture the transaction before the cutoff, or p
 <dl>
 <dd>
 
-Cancels an array of payout transactions.
+Cancel a payout transaction by ID.
 </dd>
 </dl>
 </dd>
@@ -26350,7 +26348,7 @@ Cancels an array of payout transactions.
 <dd>
 
 ```ruby
-client.money_out.cancel_all_out(request: %w[2-29 2-28 2-27])
+client.money_out.cancel_out_get(reference_id: "129-219")
 ```
 </dd>
 </dl>
@@ -26365,7 +26363,7 @@ client.money_out.cancel_all_out(request: %w[2-29 2-28 2-27])
 <dl>
 <dd>
 
-**request:** `Internal::Types::Array[String]` 
+**reference_id:** `String` — The ID for the payout transaction.
     
 </dd>
 </dl>
@@ -26385,7 +26383,7 @@ client.money_out.cancel_all_out(request: %w[2-29 2-28 2-27])
 </dl>
 </details>
 
-<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">cancel_out_get</a>(reference_id:) -> Payabli::Types::PayabliApiResponse0000</code></summary>
+<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">cancel_out_delete</a>(reference_id:) -> Payabli::Types::PayabliApiResponse0000</code></summary>
 <dl>
 <dd>
 
@@ -26412,7 +26410,7 @@ Cancel a payout transaction by ID.
 <dd>
 
 ```ruby
-client.money_out.cancel_out_get(reference_id: "129-219")
+client.money_out.cancel_out_delete(reference_id: "129-219")
 ```
 </dd>
 </dl>
@@ -26447,7 +26445,7 @@ client.money_out.cancel_out_get(reference_id: "129-219")
 </dl>
 </details>
 
-<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">cancel_out_delete</a>(reference_id:) -> Payabli::Types::PayabliApiResponse0000</code></summary>
+<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">capture_all_out</a>(request) -> Payabli::Types::CaptureAllOutResponse</code></summary>
 <dl>
 <dd>
 
@@ -26459,7 +26457,7 @@ client.money_out.cancel_out_get(reference_id: "129-219")
 <dl>
 <dd>
 
-Cancel a payout transaction by ID.
+Captures an array of authorized payout transactions for settlement. The maximum number of transactions that can be captured in a single request is 500.
 </dd>
 </dl>
 </dd>
@@ -26474,7 +26472,7 @@ Cancel a payout transaction by ID.
 <dd>
 
 ```ruby
-client.money_out.cancel_out_delete(reference_id: "129-219")
+client.money_out.capture_all_out(body: %w[2-29 2-28 2-27])
 ```
 </dd>
 </dl>
@@ -26489,7 +26487,27 @@ client.money_out.cancel_out_delete(reference_id: "129-219")
 <dl>
 <dd>
 
-**reference_id:** `String` — The ID for the payout transaction.
+**auto_convert_same_day_ach:** `Internal::Types::Boolean` 
+
+Controls what happens to a payout authorized with `sameDayACH` set to `true` when you capture it after the same-day ACH cutoff. When `true`, Payabli converts the payout to a standard ACH payment and captures it. When `false`, the capture is declined.
+
+This parameter has no effect on payouts that weren't authorized for same-day ACH.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**idempotency_key:** `String` — _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Internal::Types::Array[String]` 
     
 </dd>
 </dl>
@@ -26509,7 +26527,7 @@ client.money_out.cancel_out_delete(reference_id: "129-219")
 </dl>
 </details>
 
-<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">capture_all_out</a>(request) -> Payabli::Types::CaptureAllOutResponse</code></summary>
+<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">capture_out</a>(reference_id:) -> Payabli::Types::AuthCapturePayoutResponse</code></summary>
 <dl>
 <dd>
 
@@ -26521,7 +26539,9 @@ client.money_out.cancel_out_delete(reference_id: "129-219")
 <dl>
 <dd>
 
-Captures an array of authorized payout transactions for settlement. The maximum number of transactions that can be captured in a single request is 500.
+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.
+
+If a velocity fraud alert is triggered, the endpoint returns a `202` response with `responseCode` `9051`, and the capture is held for risk review rather than rejected. If a risk policy blocks the transaction, the endpoint returns a `422` response with `responseCode` `9005`, a terminal rejection.
 </dd>
 </dl>
 </dd>
@@ -26536,7 +26556,7 @@ Captures an array of authorized payout transactions for settlement. The maximum
 <dd>
 
 ```ruby
-client.money_out.capture_all_out(body: %w[2-29 2-28 2-27])
+client.money_out.capture_out(reference_id: "129-219")
 ```
 </dd>
 </dl>
@@ -26551,11 +26571,7 @@ client.money_out.capture_all_out(body: %w[2-29 2-28 2-27])
 <dl>
 <dd>
 
-**auto_convert_same_day_ach:** `Internal::Types::Boolean` 
-
-Controls what happens to a payout authorized with `sameDayACH` set to `true` when you capture it after the same-day ACH cutoff. When `true`, Payabli converts the payout to a standard ACH payment and captures it. When `false`, the capture is declined.
-
-This parameter has no effect on payouts that weren't authorized for same-day ACH.
+**reference_id:** `String` — The ID for the payout transaction.
     
 </dd>
 </dl>
@@ -26563,7 +26579,11 @@ This parameter has no effect on payouts that weren't authorized for same-day ACH
 <dl>
 <dd>
 
-**idempotency_key:** `String` — _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
+**auto_convert_same_day_ach:** `Internal::Types::Boolean` 
+
+Controls what happens to a payout authorized with `sameDayACH` set to `true` when you capture it after the same-day ACH cutoff. When `true`, Payabli converts the payout to a standard ACH payment and captures it. When `false`, the capture is declined.
+
+This parameter has no effect on payouts that weren't authorized for same-day ACH.
     
 </dd>
 </dl>
@@ -26571,7 +26591,7 @@ This parameter has no effect on payouts that weren't authorized for same-day ACH
 <dl>
 <dd>
 
-**request:** `Internal::Types::Array[String]` 
+**idempotency_key:** `String` — _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
     
 </dd>
 </dl>
@@ -26591,7 +26611,7 @@ This parameter has no effect on payouts that weren't authorized for same-day ACH
 </dl>
 </details>
 
-<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">capture_out</a>(reference_id:) -> Payabli::Types::AuthCapturePayoutResponse</code></summary>
+<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">payout</a>(request) -> Payabli::Types::AuthCapturePayoutResponse</code></summary>
 <dl>
 <dd>
 
@@ -26603,9 +26623,13 @@ This parameter has no effect on payouts that weren't authorized for same-day ACH
 <dl>
 <dd>
 
-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.
+Authorizes a payout and captures it in the same request, returning the capture result. Use this endpoint when you need the capture outcome synchronously: it does the same work as calling `POST /MoneyOut/authorize` followed by `GET /MoneyOut/capture/{referenceId}`, in a single call.
 
-If a velocity fraud alert is triggered, the endpoint returns a `202` response with `responseCode` `9051`, and the capture is held for risk review rather than rejected. If a risk policy blocks the transaction, the endpoint returns a `422` response with `responseCode` `9005`, a terminal rejection.
+Risk and fraud review runs at both the authorize and capture stages, exactly as it does for the two-call flow.
+
+Payabli ignores the `autoCapture` field in the request body, since this endpoint always captures inline.
+
+If the capture fails, the payout stays authorized. Retry the capture with `GET /MoneyOut/capture/{referenceId}` using the `referenceId` from the error response rather than resubmitting, which would create a second payout. See the [Manage payouts guide](/guides/pay-out-developer-payouts-manage#authorize-and-capture-in-one-call) for details.
 </dd>
 </dl>
 </dd>
@@ -26620,7 +26644,22 @@ If a velocity fraud alert is triggered, the endpoint returns a `202` response wi
 <dd>
 
 ```ruby
-client.money_out.capture_out(reference_id: "129-219")
+client.money_out.payout(
+  entry_point: "8cfec329267",
+  order_description: "Window Painting",
+  payment_method: {
+    method_: "managed"
+  },
+  payment_details: {
+    total_amount: 47
+  },
+  vendor_data: {
+    vendor_number: "VEN-123"
+  },
+  invoice_data: [{
+    bill_id: 54323
+  }]
+)
 ```
 </dd>
 </dl>
@@ -26635,7 +26674,35 @@ client.money_out.capture_out(reference_id: "129-219")
 <dl>
 <dd>
 
-**reference_id:** `String` — The ID for the payout transaction.
+**same_day_ach:** `Internal::Types::Boolean` 
+
+When `true`, Payabli authorizes the payout for same-day ACH processing instead of standard ACH. Same-day ACH must be enabled for the paypoint, otherwise the authorization fails with a `400` response and `responseCode` `3492`. Only ACH payouts honor this flag. Wire and RTP payouts ignore it.
+
+Because this endpoint captures immediately, pass `autoConvertSameDayAch` with a value of `true` to fall back to standard ACH if the capture runs after the same-day ACH cutoff.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**do_not_create_bills:** `Internal::Types::Boolean` — When `true`, Payabli won't automatically create a bill for this payout transaction.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**allow_duplicated_bills:** `Internal::Types::Boolean` — When `true`, the payout bypasses the requirement for unique bills, identified by vendor invoice number. This allows you to make more than one payout for a bill, like a split payment.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**update_vendor_payment_method:** `Internal::Types::Boolean` — When `true`, Payabli updates the vendor's stored default payment method to the method used in this payout.
     
 </dd>
 </dl>
@@ -26645,7 +26712,7 @@ client.money_out.capture_out(reference_id: "129-219")
 
 **auto_convert_same_day_ach:** `Internal::Types::Boolean` 
 
-Controls what happens to a payout authorized with `sameDayACH` set to `true` when you capture it after the same-day ACH cutoff. When `true`, Payabli converts the payout to a standard ACH payment and captures it. When `false`, the capture is declined.
+Controls what happens to a payout authorized with `sameDayACH` set to `true` when the capture runs after the same-day ACH cutoff. When `true`, Payabli converts the payout to a standard ACH payment and captures it. When `false`, the capture is declined.
 
 This parameter has no effect on payouts that weren't authorized for same-day ACH.
     
@@ -26663,6 +26730,14 @@ This parameter has no effect on payouts that weren't authorized for same-day ACH
 <dl>
 <dd>
 
+**request:** `Payabli::Types::AuthorizePayoutBody` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **request_options:** `Payabli::MoneyOut::RequestOptions` 
     
 </dd>