payabli 3.0.18 → 3.0.19

data/reference.md

@@ -3519,6 +3519,14 @@ client.subscription.update_subscription(
 <dl>
 <dd>
 
+**invoice_data:** `Payabli::Types::BillData` — Object describing an invoice linked to the subscription. Replaces the subscription's existing invoice data entirely. Send `null` to remove it, or leave it out to keep the current invoice data. See [Update a subscription](/guides/pay-in-developer-subscriptions-manage#update-a-subscription) for details.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **payment_details:** `Payabli::Types::PaymentDetail` — Object describing details of the payment. For Regular subscriptions, skip a payment by setting `totalAmount` to 0; payments pause until you update it to a non-zero value, and `serviceFee` must also be 0 when `totalAmount` is 0. For BalanceDriven subscriptions, any `totalAmount` you send is accepted but ignored at run time. Each run charges the payor's live balance, and a zero balance is skipped.
     
 </dd>
@@ -12568,6 +12576,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
 - `customerShippingState` (ct, nct, eq, ne)
 - `customerShippingCountry` (ct, nct, eq, ne)
 - `deviceId` (ct, nct, in, nin, eq, ne)
+- `DeviceEntryMode` (eq, ne, in, nin). Filters by how the device read the card: `Chip`, `Contactless`, `Swipe`, `Manual`, `Fallback`, or `None`. Case-insensitive. Separate multiple values with `|`, for example `DeviceEntryMode(in)=Chip|Contactless`. `ne` and `nin` also return transactions with no entry mode, such as non-device transactions. An unrecognized value is ignored, so the filter isn't applied.
 - `AchSecCode` ( ct, nct, in, nin, eq, ne)
 - `AchHolderType` (ct, nct, in, nin, eq, and ne)
 - `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name related to customer data
@@ -12767,6 +12776,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
 - `customerShippingState` (ct, nct, eq, ne)
 - `customerShippingCountry` (ct, nct, eq, ne)
 - `deviceId` (ct, nct, in, nin, eq, ne)
+- `DeviceEntryMode` (eq, ne, in, nin). Filters by how the device read the card: `Chip`, `Contactless`, `Swipe`, `Manual`, `Fallback`, or `None`. Case-insensitive. Separate multiple values with `|`, for example `DeviceEntryMode(in)=Chip|Contactless`. `ne` and `nin` also return transactions with no entry mode, such as non-device transactions. An unrecognized value is ignored, so the filter isn't applied.
 - `AchSecCode` ( ct, nct, in, nin, eq, ne)
 - `AchHolderType`` (ct, nct, in, nin, eq, and ne)
 - `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name related to customer data
@@ -13342,6 +13352,7 @@ Accepted field names:
   - `batchId` (ne, eq, in, nin)
   - `detailType` (eq, ne, in, nin, ct, nct)
   - `detailMethod` (eq, ne, in, nin, ct, nct)
+  - `paymentId` (ne, eq, in, nin): The payout's payment ID. Returns every transfer linked to that payout: the payout transfer, any refund and stale check refund transfers, and the billing fee transfer.
     
 </dd>
 </dl>
@@ -13471,6 +13482,7 @@ Accepted field names:
   - `batchId` (ne, eq, in, nin)
   - `detailType` (eq, ne, in, nin, ct, nct)
   - `detailMethod` (eq, ne, in, nin, ct, nct)
+  - `paymentId` (ne, eq, in, nin): The payout's payment ID. Returns every transfer linked to that payout: the payout transfer, any refund and stale check refund transfers, and the billing fee transfer.
     
 </dd>
 </dl>
@@ -25330,6 +25342,7 @@ client.vendor.add_vendor(
   remit_zip: "31113",
   state: "FL",
   vendor_status: 1,
+  issue_1099: true,
   zip: "33139"
 )
 ```
@@ -25914,7 +25927,7 @@ Creates a ghost card, a multi-use virtual debit card issued to a vendor for recu
 
 Unlike single-use virtual cards issued as part of a payout transaction, ghost cards aren't tied to a specific payout. They're issued directly to a vendor and can be reused up to a configurable number of times within the card's spending limits.
 
-Only one ghost card can exist per vendor per paypoint. To issue a new card to the same vendor, cancel the existing card first.
+Only one active ghost card can exist per vendor per paypoint. If the vendor already has one, the request fails with error `7067`. To issue a new card to the same vendor, cancel the existing card first. Canceled and expired cards don't count toward this limit. See [Cancel ghost card](/developers/api-reference/cards/cancel-ghost-card).
 </dd>
 </dl>
 </dd>
@@ -26105,6 +26118,72 @@ client.ghost_card.create_ghost_card(
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.ghost_card.<a href="/lib/payabli/ghost_card/client.rb">delete_ghost_card</a>(card_token:) -> Payabli::Types::DeleteGhostCardResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Cancels a ghost card. This is always a soft delete: Payabli keeps the card record, including its transaction history.
+
+Canceling a ghost card frees the vendor's slot, so you can issue a new ghost card to the same vendor. A card canceled with this endpoint can't be used, reactivated, or canceled again.
+
+Requires the `vcard_delete` permission.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.ghost_card.delete_ghost_card(card_token: "gc_abc123def456")
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**card_token:** `String` — Token that identifies the ghost card to cancel. This is the `ReferenceId` returned when the card was created.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Payabli::GhostCard::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -27224,6 +27303,85 @@ client.money_out.update_check_payment_status(
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">get_next_check_number</a>(paypoint_id:, account_id:) -> Payabli::Types::NextCheckNumberResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns a suggested check number for the next check payout from a paypoint's funding account. Payabli suggests the highest check number on the account's check payouts plus one, or `1` if the account has no check history. Canceled check payouts don't count toward the highest number.
+
+
+Use the suggested value with the `checkNumber` field when you reissue a check, or when you create a new check payout.
+
+
+Errors return HTTP `400`: `3005` when the paypoint ID is invalid or inactive, and `3758` when the account ID isn't valid for the paypoint.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.money_out.get_next_check_number(
+  paypoint_id: 3040,
+  account_id: "123-456"
+)
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**paypoint_id:** `Integer` — The ID of the paypoint that owns the funding account.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**account_id:** `String` — The `accountId` of the bank account linked to the paypoint's check service, such as `123-456`. Find it in the paypoint's bank account details (`BankData`).
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `Payabli::MoneyOut::RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -27242,7 +27400,7 @@ client.money_out.update_check_payment_status(
 
 Reissues a payout transaction with a new payment method. This creates a new transaction linked to the original and marks the original transaction as reissued.
 
-The original transaction must be in **Processing** or **Processed** status. The payment method in the request body is used directly. The endpoint doesn't fall back to vendor-managed payment methods.
+The original transaction must be in **Processing** or **Processed** status. An ACH payout with a **Returned** status can also be reissued. The payment method in the request body is used directly. The endpoint doesn't fall back to vendor-managed payment methods.
 
 The new transaction goes through the standard authorize-and-capture flow automatically. Both the original and new transactions are linked through their event histories for audit purposes.
 
@@ -27310,6 +27468,14 @@ client.money_out.reissue_out(
 <dl>
 <dd>
 
+**check_number:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **request_options:** `Payabli::MoneyOut::RequestOptions` 
     
 </dd>