payabli 3.0.8 → 3.0.9
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.
- checksums.yaml +4 -4
- data/.fern/metadata.json +4 -4
- data/lib/payabli/client.rb +6 -1
- data/lib/payabli/cloud/client.rb +2 -2
- data/lib/payabli/device/client.rb +63 -0
- data/lib/payabli/funding/client.rb +1 -1
- data/lib/payabli/money_in/client.rb +16 -56
- data/lib/payabli/money_out/client.rb +2 -4
- data/lib/payabli/money_out/types/request_out_authorize.rb +1 -3
- data/lib/payabli/types/device_challenge_data.rb +12 -0
- data/lib/payabli/types/device_challenge_response.rb +21 -0
- data/lib/payabli/types/methodall.rb +1 -0
- data/lib/payabli/types/operation_result.rb +4 -2
- data/lib/payabli/types/pay_method_cloud.rb +0 -2
- data/lib/payabli/types/pay_method_device.rb +14 -0
- data/lib/payabli/types/pay_method_device_method.rb +11 -0
- data/lib/payabli/types/payment_method.rb +2 -0
- data/lib/payabli/types/paypoint_data.rb +2 -0
- data/lib/payabli/types/request_out_authorize_invoice_data.rb +4 -25
- data/lib/payabli/types/request_out_authorize_vendor_data.rb +3 -61
- data/lib/payabli/types/transaction_detail_payment_data.rb +2 -2
- data/lib/payabli/types/v_2_transaction_detail_response_data.rb +1 -1
- data/lib/payabli/types/v_2_transaction_details.rb +1 -1
- data/lib/payabli/version.rb +1 -1
- data/lib/payabli.rb +5 -2
- data/reference.md +91 -67
- data/wiremock/wiremock-mappings.json +90 -59
- metadata +7 -4
- data/lib/payabli/types/lot_number.rb +0 -23
- data/lib/payabli/types/request_out_authorize_vendor_billing_data.rb +0 -19
data/reference.md
CHANGED
|
@@ -1599,22 +1599,12 @@ Only card transactions can be authorized. This endpoint can't be used for ACH tr
|
|
|
1599
1599
|
|
|
1600
1600
|
```ruby
|
|
1601
1601
|
client.money_in.authorize(
|
|
1602
|
-
customer_data: {
|
|
1603
|
-
customer_id: 4440
|
|
1604
|
-
},
|
|
1605
|
-
entry_point: "8cfec329267",
|
|
1606
|
-
ipaddress: "255.255.255.255",
|
|
1607
1602
|
payment_details: {
|
|
1608
|
-
|
|
1609
|
-
total_amount: 100
|
|
1603
|
+
total_amount: 1.1
|
|
1610
1604
|
},
|
|
1611
1605
|
payment_method: {
|
|
1612
|
-
|
|
1613
|
-
|
|
1614
|
-
card_holder: "John Cassian",
|
|
1615
|
-
cardnumber: "4111111111111111",
|
|
1616
|
-
cardzip: "12345",
|
|
1617
|
-
initiator: "payor",
|
|
1606
|
+
cardexp: "cardexp",
|
|
1607
|
+
cardnumber: "cardnumber",
|
|
1618
1608
|
method_: "card"
|
|
1619
1609
|
}
|
|
1620
1610
|
)
|
|
@@ -1701,8 +1691,8 @@ transaction](/developers/api-reference/moneyin/authorize-a-transaction) to compl
|
|
|
1701
1691
|
|
|
1702
1692
|
```ruby
|
|
1703
1693
|
client.money_in.capture(
|
|
1704
|
-
trans_id: "
|
|
1705
|
-
amount:
|
|
1694
|
+
trans_id: "transId",
|
|
1695
|
+
amount: 1.1
|
|
1706
1696
|
)
|
|
1707
1697
|
```
|
|
1708
1698
|
</dd>
|
|
@@ -1780,10 +1770,9 @@ You can use this endpoint to capture both full and partial amounts of the origin
|
|
|
1780
1770
|
|
|
1781
1771
|
```ruby
|
|
1782
1772
|
client.money_in.capture_auth(
|
|
1783
|
-
trans_id: "
|
|
1773
|
+
trans_id: "transId",
|
|
1784
1774
|
payment_details: {
|
|
1785
|
-
total_amount:
|
|
1786
|
-
service_fee: 5
|
|
1775
|
+
total_amount: 1.1
|
|
1787
1776
|
}
|
|
1788
1777
|
)
|
|
1789
1778
|
```
|
|
@@ -2084,22 +2073,12 @@ Make a single transaction. This method authorizes and captures a payment in one
|
|
|
2084
2073
|
|
|
2085
2074
|
```ruby
|
|
2086
2075
|
client.money_in.getpaid(
|
|
2087
|
-
customer_data: {
|
|
2088
|
-
customer_id: 4440
|
|
2089
|
-
},
|
|
2090
|
-
entry_point: "8cfec329267",
|
|
2091
|
-
ipaddress: "255.255.255.255",
|
|
2092
2076
|
payment_details: {
|
|
2093
|
-
|
|
2094
|
-
total_amount: 100
|
|
2077
|
+
total_amount: 1.1
|
|
2095
2078
|
},
|
|
2096
2079
|
payment_method: {
|
|
2097
|
-
|
|
2098
|
-
|
|
2099
|
-
card_holder: "John Cassian",
|
|
2100
|
-
cardnumber: "4111111111111111",
|
|
2101
|
-
cardzip: "12345",
|
|
2102
|
-
initiator: "payor",
|
|
2080
|
+
cardexp: "cardexp",
|
|
2081
|
+
cardnumber: "cardnumber",
|
|
2103
2082
|
method_: "card"
|
|
2104
2083
|
}
|
|
2105
2084
|
)
|
|
@@ -2209,8 +2188,8 @@ A reversal either refunds or voids a transaction independent of the transaction'
|
|
|
2209
2188
|
|
|
2210
2189
|
```ruby
|
|
2211
2190
|
client.money_in.reverse(
|
|
2212
|
-
trans_id: "
|
|
2213
|
-
amount:
|
|
2191
|
+
trans_id: "transId",
|
|
2192
|
+
amount: 1.1
|
|
2214
2193
|
)
|
|
2215
2194
|
```
|
|
2216
2195
|
</dd>
|
|
@@ -2292,8 +2271,8 @@ Refund a transaction that has settled and send money back to the account holder.
|
|
|
2292
2271
|
|
|
2293
2272
|
```ruby
|
|
2294
2273
|
client.money_in.refund(
|
|
2295
|
-
trans_id: "
|
|
2296
|
-
amount:
|
|
2274
|
+
trans_id: "transId",
|
|
2275
|
+
amount: 1.1
|
|
2297
2276
|
)
|
|
2298
2277
|
```
|
|
2299
2278
|
</dd>
|
|
@@ -2374,26 +2353,7 @@ Refunds a settled transaction with split instructions.
|
|
|
2374
2353
|
<dd>
|
|
2375
2354
|
|
|
2376
2355
|
```ruby
|
|
2377
|
-
client.money_in.refund_with_instructions(
|
|
2378
|
-
trans_id: "10-3ffa27df-b171-44e0-b251-e95fbfc7a723",
|
|
2379
|
-
idempotency_key: "8A29FC40-CA47-1067-B31D-00DD010662DB",
|
|
2380
|
-
amount: 100,
|
|
2381
|
-
order_description: "Materials deposit",
|
|
2382
|
-
refund_details: {
|
|
2383
|
-
split_refunding: [{
|
|
2384
|
-
origination_entry_point: "7f1a381696",
|
|
2385
|
-
account_id: "187-342",
|
|
2386
|
-
description: "Refunding undelivered materials",
|
|
2387
|
-
amount: 60
|
|
2388
|
-
}, {
|
|
2389
|
-
origination_entry_point: "7f1a381696",
|
|
2390
|
-
account_id: "187-343",
|
|
2391
|
-
description: "Refunding deposit for undelivered materials",
|
|
2392
|
-
amount: 40
|
|
2393
|
-
}]
|
|
2394
|
-
},
|
|
2395
|
-
source: "api"
|
|
2396
|
-
)
|
|
2356
|
+
client.money_in.refund_with_instructions(trans_id: "transId")
|
|
2397
2357
|
```
|
|
2398
2358
|
</dd>
|
|
2399
2359
|
</dl>
|
|
@@ -2772,7 +2732,7 @@ Cancel a transaction that hasn't been settled yet. Voiding non-captured authoriz
|
|
|
2772
2732
|
<dd>
|
|
2773
2733
|
|
|
2774
2734
|
```ruby
|
|
2775
|
-
client.money_in.void(trans_id: "
|
|
2735
|
+
client.money_in.void(trans_id: "transId")
|
|
2776
2736
|
```
|
|
2777
2737
|
</dd>
|
|
2778
2738
|
</dl>
|
|
@@ -15338,6 +15298,78 @@ client.notificationlogs.bulk_retry_notification_logs(request: %w[550e8400-e29b-4
|
|
|
15338
15298
|
</dl>
|
|
15339
15299
|
|
|
15340
15300
|
|
|
15301
|
+
</dd>
|
|
15302
|
+
</dl>
|
|
15303
|
+
</details>
|
|
15304
|
+
|
|
15305
|
+
## Device
|
|
15306
|
+
<details><summary><code>client.device.<a href="/lib/payabli/device/client.rb">challenge</a>(entry:) -> Payabli::Types::DeviceChallengeResponse</code></summary>
|
|
15307
|
+
<dl>
|
|
15308
|
+
<dd>
|
|
15309
|
+
|
|
15310
|
+
#### 📝 Description
|
|
15311
|
+
|
|
15312
|
+
<dl>
|
|
15313
|
+
<dd>
|
|
15314
|
+
|
|
15315
|
+
<dl>
|
|
15316
|
+
<dd>
|
|
15317
|
+
|
|
15318
|
+
Generates a one-time, 6-digit verification code for activating a
|
|
15319
|
+
semi-integrated card-present device in a paypoint. After calling this endpoint, an operator enters the returned code
|
|
15320
|
+
on the device's terminal, along with a device name, to register the
|
|
15321
|
+
device to the paypoint resolved from `{entry}`.
|
|
15322
|
+
|
|
15323
|
+
A code expires 5 minutes after it's issued. A paypoint can have several
|
|
15324
|
+
codes active at once — for example, when activating a batch of devices —
|
|
15325
|
+
and a code binds to whichever device enters it first.
|
|
15326
|
+
|
|
15327
|
+
Authenticate with an OAuth2 Bearer token that has the `device_registry` scope.
|
|
15328
|
+
</dd>
|
|
15329
|
+
</dl>
|
|
15330
|
+
</dd>
|
|
15331
|
+
</dl>
|
|
15332
|
+
|
|
15333
|
+
#### 🔌 Usage
|
|
15334
|
+
|
|
15335
|
+
<dl>
|
|
15336
|
+
<dd>
|
|
15337
|
+
|
|
15338
|
+
<dl>
|
|
15339
|
+
<dd>
|
|
15340
|
+
|
|
15341
|
+
```ruby
|
|
15342
|
+
client.device.challenge(entry: "8cfec329267")
|
|
15343
|
+
```
|
|
15344
|
+
</dd>
|
|
15345
|
+
</dl>
|
|
15346
|
+
</dd>
|
|
15347
|
+
</dl>
|
|
15348
|
+
|
|
15349
|
+
#### ⚙️ Parameters
|
|
15350
|
+
|
|
15351
|
+
<dl>
|
|
15352
|
+
<dd>
|
|
15353
|
+
|
|
15354
|
+
<dl>
|
|
15355
|
+
<dd>
|
|
15356
|
+
|
|
15357
|
+
**entry:** `String` — The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
15358
|
+
|
|
15359
|
+
</dd>
|
|
15360
|
+
</dl>
|
|
15361
|
+
|
|
15362
|
+
<dl>
|
|
15363
|
+
<dd>
|
|
15364
|
+
|
|
15365
|
+
**request_options:** `Payabli::Device::RequestOptions`
|
|
15366
|
+
|
|
15367
|
+
</dd>
|
|
15368
|
+
</dl>
|
|
15369
|
+
</dd>
|
|
15370
|
+
</dl>
|
|
15371
|
+
|
|
15372
|
+
|
|
15341
15373
|
</dd>
|
|
15342
15374
|
</dl>
|
|
15343
15375
|
</details>
|
|
@@ -15597,7 +15629,7 @@ client.cloud.history_device(
|
|
|
15597
15629
|
<dl>
|
|
15598
15630
|
<dd>
|
|
15599
15631
|
|
|
15600
|
-
Use [List devices by paypoint](/developers/api-reference/
|
|
15632
|
+
Use [List devices by paypoint](/developers/api-reference/get-list-of-devices-for-a-paypoint) instead, which supports filters, sorting, and pagination.
|
|
15601
15633
|
|
|
15602
15634
|
Get a list of cloud devices registered to an entrypoint.
|
|
15603
15635
|
</dd>
|
|
@@ -26163,14 +26195,6 @@ client.money_out.authorize_out(
|
|
|
26163
26195
|
<dl>
|
|
26164
26196
|
<dd>
|
|
26165
26197
|
|
|
26166
|
-
**force_vendor_creation:** `Internal::Types::Boolean` — When `true`, the request creates a new vendor record, regardless of whether the vendor already exists.
|
|
26167
|
-
|
|
26168
|
-
</dd>
|
|
26169
|
-
</dl>
|
|
26170
|
-
|
|
26171
|
-
<dl>
|
|
26172
|
-
<dd>
|
|
26173
|
-
|
|
26174
26198
|
**same_day_ach:** `Internal::Types::Boolean`
|
|
26175
26199
|
|
|
26176
26200
|
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.
|
|
@@ -26247,7 +26271,7 @@ Same-day ACH has a daily cutoff. Capture the transaction before the cutoff, or p
|
|
|
26247
26271
|
<dl>
|
|
26248
26272
|
<dd>
|
|
26249
26273
|
|
|
26250
|
-
**invoice_data:** `Internal::Types::Array[Payabli::Types::RequestOutAuthorizeInvoiceData]` —
|
|
26274
|
+
**invoice_data:** `Internal::Types::Array[Payabli::Types::RequestOutAuthorizeInvoiceData]` — Bills to pay with this payout, each referenced by `billId`.
|
|
26251
26275
|
|
|
26252
26276
|
</dd>
|
|
26253
26277
|
</dl>
|
|
@@ -27194,7 +27218,7 @@ Deposits funds into a paypoint's available payout balance. Deposited funds enter
|
|
|
27194
27218
|
|
|
27195
27219
|
```ruby
|
|
27196
27220
|
client.funding.deposit_funds(
|
|
27197
|
-
amount:
|
|
27221
|
+
amount: 1500,
|
|
27198
27222
|
entrypoint: "48acde49",
|
|
27199
27223
|
account_id: "333"
|
|
27200
27224
|
)
|