payabli 3.0.1 → 3.0.3
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 +5 -5
- data/README.md +4 -1
- data/lib/payabli/client.rb +38 -4
- data/lib/payabli/customer/client.rb +1 -1
- data/lib/payabli/funding/client.rb +49 -0
- data/lib/payabli/funding/types/deposit_funds_request.rb +19 -0
- data/lib/payabli/internal/http/raw_client.rb +28 -5
- data/lib/payabli/internal/oauth_provider.rb +67 -0
- data/lib/payabli/money_in/client.rb +79 -35
- data/lib/payabli/money_out/client.rb +63 -3
- data/lib/payabli/money_out/types/renew_v_card_request.rb +13 -0
- data/lib/payabli/payment_link/client.rb +7 -0
- data/lib/payabli/payment_link/types/pay_link_data_invoice.rb +1 -1
- data/lib/payabli/token/client.rb +51 -0
- data/lib/payabli/token/types/create_server_side_token_request.rb +17 -0
- data/lib/payabli/types/add_device_response.rb +4 -0
- data/lib/payabli/types/add_method_response.rb +4 -0
- data/lib/payabli/types/add_response_response.rb +4 -0
- data/lib/payabli/types/auth_capture_payout_response_data.rb +2 -0
- data/lib/payabli/types/authorize_payment_method.rb +4 -0
- data/lib/payabli/types/bill_pay_out_data.rb +15 -9
- data/lib/payabli/types/cancel_payout_response_data.rb +27 -0
- data/lib/payabli/types/capture_all_out_response_response_data_item.rb +2 -0
- data/lib/payabli/types/contacts_response.rb +3 -3
- data/lib/payabli/types/deposit_funds_response.rb +16 -0
- data/lib/payabli/types/get_method_response_response_data_customers_item.rb +42 -0
- data/lib/payabli/types/get_pay_link_from_id_response.rb +4 -0
- data/lib/payabli/types/method_element.rb +4 -0
- data/lib/payabli/types/methods_list.rb +6 -0
- data/lib/payabli/types/modify_approval_bill_response.rb +4 -0
- data/lib/payabli/types/notification_log_detail.rb +24 -0
- data/lib/payabli/types/payabli_access_token_response.rb +17 -0
- data/lib/payabli/types/payabli_api_response_0000.rb +1 -1
- data/lib/payabli/types/query_payout_transaction_records_item.rb +54 -34
- data/lib/payabli/types/query_payout_transaction_records_item_payment_data.rb +16 -16
- data/lib/payabli/types/query_payout_transaction_summary.rb +17 -17
- data/lib/payabli/types/query_response_settlements_records_item.rb +2 -0
- data/lib/payabli/types/query_transaction_events.rb +2 -2
- data/lib/payabli/types/refund_v_2_request.rb +21 -0
- data/lib/payabli/types/remove_device_response.rb +4 -0
- data/lib/payabli/types/renew_v_card_response.rb +13 -0
- data/lib/payabli/types/renew_v_card_response_data.rb +25 -0
- data/lib/payabli/types/set_approved_bill_response.rb +4 -0
- data/lib/payabli/types/settlement_split_funding_detail.rb +23 -0
- data/lib/payabli/types/stat_basic_extended_query_record.rb +8 -0
- data/lib/payabli/types/token_error_response.rb +13 -0
- data/lib/payabli/types/tokenize_ach.rb +0 -2
- data/lib/payabli/types/tokenize_card.rb +2 -0
- data/lib/payabli/types/transfer_out_record.rb +4 -0
- data/lib/payabli/types/vendor_call_status_completed.rb +20 -0
- data/lib/payabli/types/vendor_call_status_extracted_data.rb +12 -0
- data/lib/payabli/types/vendor_call_status_failed.rb +18 -0
- data/lib/payabli/types/vendor_call_status_response.rb +18 -0
- data/lib/payabli/types/vendor_call_status_scheduled.rb +14 -0
- data/lib/payabli/types/vendor_data.rb +1 -1
- data/lib/payabli/types/vendor_query_record.rb +45 -41
- data/lib/payabli/types/vendor_schedule_call_response.rb +20 -0
- data/lib/payabli/types/vendor_schedule_call_response_data.rb +16 -0
- data/lib/payabli/types/vendoridtrans.rb +23 -0
- data/lib/payabli/vendor/client.rb +79 -0
- data/lib/payabli/vendor/types/schedule_enrichment_call_request.rb +27 -0
- data/lib/payabli/version.rb +1 -1
- data/lib/payabli.rb +36 -13
- data/reference.md +675 -163
- data/wiremock/docker-compose.test.yml +1 -1
- data/wiremock/wiremock-mappings.json +258 -93
- metadata +25 -2
data/reference.md
CHANGED
|
@@ -339,8 +339,8 @@ Retrieves a file attached to a bill, either as a binary file or as a Base64-enco
|
|
|
339
339
|
|
|
340
340
|
```ruby
|
|
341
341
|
client.bill.get_attached_from_bill(
|
|
342
|
-
filename: "0_Bill.pdf",
|
|
343
342
|
id_bill: 285,
|
|
343
|
+
filename: "0_Bill.pdf",
|
|
344
344
|
return_object: true
|
|
345
345
|
)
|
|
346
346
|
```
|
|
@@ -425,8 +425,8 @@ Delete a file attached to a bill.
|
|
|
425
425
|
|
|
426
426
|
```ruby
|
|
427
427
|
client.bill.delete_attached_from_bill(
|
|
428
|
-
|
|
429
|
-
|
|
428
|
+
id_bill: 285,
|
|
429
|
+
filename: "0_Bill.pdf"
|
|
430
430
|
)
|
|
431
431
|
```
|
|
432
432
|
</dd>
|
|
@@ -673,8 +673,8 @@ Approve or disapprove a bill by ID.
|
|
|
673
673
|
|
|
674
674
|
```ruby
|
|
675
675
|
client.bill.set_approved_bill(
|
|
676
|
-
|
|
677
|
-
|
|
676
|
+
id_bill: 285,
|
|
677
|
+
approved: "true"
|
|
678
678
|
)
|
|
679
679
|
```
|
|
680
680
|
</dd>
|
|
@@ -1041,7 +1041,7 @@ Example: totalAmount(gt)=20 return all records with totalAmount greater than 20.
|
|
|
1041
1041
|
<dl>
|
|
1042
1042
|
<dd>
|
|
1043
1043
|
|
|
1044
|
-
Creates a customer in an entrypoint. An identifier is required to create customer records. Change your identifier settings in Settings > Custom Fields in
|
|
1044
|
+
Creates a customer in an entrypoint. An identifier is required to create customer records. Change your identifier settings in Settings > Custom Fields in the Payabli Portal.
|
|
1045
1045
|
If you don't include an identifier, the record is rejected.
|
|
1046
1046
|
</dd>
|
|
1047
1047
|
</dl>
|
|
@@ -1179,7 +1179,7 @@ client.customer.get_customer(customer_id: 4440)
|
|
|
1179
1179
|
<dl>
|
|
1180
1180
|
<dd>
|
|
1181
1181
|
|
|
1182
|
-
**customer_id:** `Integer` — Payabli-generated customer ID. Maps to "Customer ID" column in
|
|
1182
|
+
**customer_id:** `Integer` — Payabli-generated customer ID. Maps to "Customer ID" column in the Payabli Portal.
|
|
1183
1183
|
|
|
1184
1184
|
</dd>
|
|
1185
1185
|
</dl>
|
|
@@ -1250,7 +1250,7 @@ client.customer.update_customer(
|
|
|
1250
1250
|
<dl>
|
|
1251
1251
|
<dd>
|
|
1252
1252
|
|
|
1253
|
-
**customer_id:** `Integer` — Payabli-generated customer ID. Maps to "Customer ID" column in
|
|
1253
|
+
**customer_id:** `Integer` — Payabli-generated customer ID. Maps to "Customer ID" column in the Payabli Portal.
|
|
1254
1254
|
|
|
1255
1255
|
</dd>
|
|
1256
1256
|
</dl>
|
|
@@ -1320,7 +1320,7 @@ client.customer.delete_customer(customer_id: 4440)
|
|
|
1320
1320
|
<dl>
|
|
1321
1321
|
<dd>
|
|
1322
1322
|
|
|
1323
|
-
**customer_id:** `Integer` — Payabli-generated customer ID. Maps to "Customer ID" column in
|
|
1323
|
+
**customer_id:** `Integer` — Payabli-generated customer ID. Maps to "Customer ID" column in the Payabli Portal.
|
|
1324
1324
|
|
|
1325
1325
|
</dd>
|
|
1326
1326
|
</dl>
|
|
@@ -1382,7 +1382,7 @@ client.customer.request_consent(customer_id: 4440)
|
|
|
1382
1382
|
<dl>
|
|
1383
1383
|
<dd>
|
|
1384
1384
|
|
|
1385
|
-
**customer_id:** `Integer` — Payabli-generated customer ID. Maps to "Customer ID" column in
|
|
1385
|
+
**customer_id:** `Integer` — Payabli-generated customer ID. Maps to "Customer ID" column in the Payabli Portal.
|
|
1386
1386
|
|
|
1387
1387
|
</dd>
|
|
1388
1388
|
</dl>
|
|
@@ -1447,7 +1447,7 @@ client.customer.link_customer_transaction(
|
|
|
1447
1447
|
<dl>
|
|
1448
1448
|
<dd>
|
|
1449
1449
|
|
|
1450
|
-
**customer_id:** `Integer` — Payabli-generated customer ID. Maps to "Customer ID" column in
|
|
1450
|
+
**customer_id:** `Integer` — Payabli-generated customer ID. Maps to "Customer ID" column in the Payabli Portal.
|
|
1451
1451
|
|
|
1452
1452
|
</dd>
|
|
1453
1453
|
</dl>
|
|
@@ -1580,11 +1580,14 @@ client.check_capture.check_processing(
|
|
|
1580
1580
|
<dl>
|
|
1581
1581
|
<dd>
|
|
1582
1582
|
|
|
1583
|
+
<Warning>
|
|
1584
|
+
This endpoint is deprecated. New integrations should use the [Authorize endpoint](/developers/api-reference/moneyinV2/authorize-a-transaction), then capture, void, or refund the resulting transaction with the corresponding endpoints. Transactions created with this legacy endpoint must be managed with the legacy lifecycle endpoints — they aren't interchangeable with the current ones.
|
|
1585
|
+
</Warning>
|
|
1586
|
+
|
|
1587
|
+
|
|
1583
1588
|
Authorize a card transaction. This returns an authorization code and reserves funds for the merchant. Authorized transactions aren't flagged for settlement until [captured](/developers/api-reference/moneyin/capture-an-authorized-transaction).
|
|
1589
|
+
|
|
1584
1590
|
Only card transactions can be authorized. This endpoint can't be used for ACH transactions.
|
|
1585
|
-
<Tip>
|
|
1586
|
-
Consider migrating to the [v2 Authorize endpoint](/developers/api-reference/moneyinV2/authorize-a-transaction) to take advantage of unified response codes and improved response consistency.
|
|
1587
|
-
</Tip>
|
|
1588
1591
|
</dd>
|
|
1589
1592
|
</dl>
|
|
1590
1593
|
</dd>
|
|
@@ -1682,7 +1685,7 @@ client.money_in.authorize(
|
|
|
1682
1685
|
<dd>
|
|
1683
1686
|
|
|
1684
1687
|
<Warning>
|
|
1685
|
-
This endpoint is deprecated
|
|
1688
|
+
This endpoint is deprecated. Use [POST `/capture/{transId}`](/developers/api-reference/moneyin/capture-an-authorized-transaction) instead, which supports partial captures and service fee adjustments.
|
|
1686
1689
|
</Warning>
|
|
1687
1690
|
|
|
1688
1691
|
Capture an [authorized
|
|
@@ -1759,13 +1762,13 @@ client.money_in.capture(
|
|
|
1759
1762
|
<dl>
|
|
1760
1763
|
<dd>
|
|
1761
1764
|
|
|
1765
|
+
<Warning>
|
|
1766
|
+
This endpoint is deprecated. Use it only to capture transactions originally authorized with the legacy [Authorize endpoint](/developers/api-reference/moneyin/authorize-a-transaction). New integrations should use the [Capture endpoint](/developers/api-reference/moneyinV2/capture-an-authorized-transaction), which only works on transactions authorized with the current [Authorize endpoint](/developers/api-reference/moneyinV2/authorize-a-transaction).
|
|
1767
|
+
</Warning>
|
|
1768
|
+
|
|
1762
1769
|
Capture an [authorized transaction](/developers/api-reference/moneyin/authorize-a-transaction) to complete the transaction and move funds from the customer to merchant account.
|
|
1763
1770
|
|
|
1764
1771
|
You can use this endpoint to capture both full and partial amounts of the original authorized transaction. See [Capture an authorized transaction](/developers/developer-guides/pay-in-auth-and-capture) for more information about this endpoint.
|
|
1765
|
-
|
|
1766
|
-
<Tip>
|
|
1767
|
-
Consider migrating to the [v2 Capture endpoint](/developers/api-reference/moneyinV2/capture-an-authorized-transaction) to take advantage of unified response codes and improved response consistency.
|
|
1768
|
-
</Tip>
|
|
1769
1772
|
</dd>
|
|
1770
1773
|
</dl>
|
|
1771
1774
|
</dd>
|
|
@@ -2065,11 +2068,11 @@ client.money_in.details(trans_id: "45-as456777hhhhhhhhhh77777777-324")
|
|
|
2065
2068
|
<dl>
|
|
2066
2069
|
<dd>
|
|
2067
2070
|
|
|
2068
|
-
|
|
2071
|
+
<Warning>
|
|
2072
|
+
This endpoint is deprecated. New integrations should use the [Make a transaction endpoint](/developers/api-reference/moneyinV2/make-a-transaction) and manage the resulting transaction with the corresponding void or refund endpoints. Transactions created with this legacy endpoint must be managed with the legacy lifecycle endpoints — they aren't interchangeable with the current ones.
|
|
2073
|
+
</Warning>
|
|
2069
2074
|
|
|
2070
|
-
|
|
2071
|
-
Consider migrating to the [v2 Make a transaction endpoint](/developers/api-reference/moneyinV2/make-a-transaction) to take advantage of unified response codes and improved response consistency.
|
|
2072
|
-
</Tip>
|
|
2075
|
+
Make a single transaction. This method authorizes and captures a payment in one step.
|
|
2073
2076
|
</dd>
|
|
2074
2077
|
</dl>
|
|
2075
2078
|
</dd>
|
|
@@ -2190,7 +2193,11 @@ client.money_in.getpaid(
|
|
|
2190
2193
|
<dl>
|
|
2191
2194
|
<dd>
|
|
2192
2195
|
|
|
2193
|
-
|
|
2196
|
+
<Warning>
|
|
2197
|
+
This endpoint is deprecated and only works on transactions created with the legacy endpoints. There's no equivalent in the current endpoints. For transactions created with [Make a transaction](/developers/api-reference/moneyinV2/make-a-transaction) or [Authorize](/developers/api-reference/moneyinV2/authorize-a-transaction), check the transaction's settlement status and call [Void](/developers/api-reference/moneyinV2/void-a-transaction) or [Refund](/developers/api-reference/moneyinV2/refund-a-settled-transaction) based on the result.
|
|
2198
|
+
</Warning>
|
|
2199
|
+
|
|
2200
|
+
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 legacy endpoints. For transactions made with the current endpoints, check the transaction's settlement status and call void or refund based on the result.
|
|
2194
2201
|
</dd>
|
|
2195
2202
|
</dl>
|
|
2196
2203
|
</dd>
|
|
@@ -2206,8 +2213,8 @@ A reversal either refunds or voids a transaction independent of the transaction'
|
|
|
2206
2213
|
|
|
2207
2214
|
```ruby
|
|
2208
2215
|
client.money_in.reverse(
|
|
2209
|
-
|
|
2210
|
-
|
|
2216
|
+
trans_id: "10-3ffa27df-b171-44e0-b251-e95fbfc7a723",
|
|
2217
|
+
amount: 0
|
|
2211
2218
|
)
|
|
2212
2219
|
```
|
|
2213
2220
|
</dd>
|
|
@@ -2269,11 +2276,11 @@ An amount equal to zero will refunds the total amount authorized minus any servi
|
|
|
2269
2276
|
<dl>
|
|
2270
2277
|
<dd>
|
|
2271
2278
|
|
|
2272
|
-
|
|
2279
|
+
<Warning>
|
|
2280
|
+
This endpoint is deprecated. Use it only to refund transactions originally created with the legacy endpoints. New integrations should use the [Refund endpoint](/developers/api-reference/moneyinV2/refund-a-settled-transaction), which only works on transactions created with [Make a transaction](/developers/api-reference/moneyinV2/make-a-transaction) or [Authorize](/developers/api-reference/moneyinV2/authorize-a-transaction).
|
|
2281
|
+
</Warning>
|
|
2273
2282
|
|
|
2274
|
-
|
|
2275
|
-
Consider migrating to the [v2 Refund endpoint](/developers/api-reference/moneyinV2/refund-a-settled-transaction) to take advantage of unified response codes and improved response consistency.
|
|
2276
|
-
</Tip>
|
|
2283
|
+
Refund a transaction that has settled and send money back to the account holder. If a transaction hasn't been settled, void it instead.
|
|
2277
2284
|
</dd>
|
|
2278
2285
|
</dl>
|
|
2279
2286
|
</dd>
|
|
@@ -2289,8 +2296,8 @@ Refund a transaction that has settled and send money back to the account holder.
|
|
|
2289
2296
|
|
|
2290
2297
|
```ruby
|
|
2291
2298
|
client.money_in.refund(
|
|
2292
|
-
|
|
2293
|
-
|
|
2299
|
+
trans_id: "10-3ffa27df-b171-44e0-b251-e95fbfc7a723",
|
|
2300
|
+
amount: 0
|
|
2294
2301
|
)
|
|
2295
2302
|
```
|
|
2296
2303
|
</dd>
|
|
@@ -2352,6 +2359,10 @@ An amount equal to zero will refund the total amount authorized minus any servic
|
|
|
2352
2359
|
<dl>
|
|
2353
2360
|
<dd>
|
|
2354
2361
|
|
|
2362
|
+
<Warning>
|
|
2363
|
+
This endpoint is deprecated. Use it only to refund transactions originally created with the legacy endpoints. To refund a split-funded transaction created with [Make a transaction](/developers/api-reference/moneyinV2/make-a-transaction) or [Authorize](/developers/api-reference/moneyinV2/authorize-a-transaction), use the [Refund endpoint](/developers/api-reference/moneyinV2/refund-a-settled-transaction) with split instructions in the request body.
|
|
2364
|
+
</Warning>
|
|
2365
|
+
|
|
2355
2366
|
Refunds a settled transaction with split instructions.
|
|
2356
2367
|
</dd>
|
|
2357
2368
|
</dl>
|
|
@@ -2370,9 +2381,8 @@ Refunds a settled transaction with split instructions.
|
|
|
2370
2381
|
client.money_in.refund_with_instructions(
|
|
2371
2382
|
trans_id: "10-3ffa27df-b171-44e0-b251-e95fbfc7a723",
|
|
2372
2383
|
idempotency_key: "8A29FC40-CA47-1067-B31D-00DD010662DB",
|
|
2373
|
-
source: "api",
|
|
2374
|
-
order_description: "Materials deposit",
|
|
2375
2384
|
amount: 100,
|
|
2385
|
+
order_description: "Materials deposit",
|
|
2376
2386
|
refund_details: {
|
|
2377
2387
|
split_refunding: [{
|
|
2378
2388
|
origination_entry_point: "7f1a381696",
|
|
@@ -2385,7 +2395,8 @@ client.money_in.refund_with_instructions(
|
|
|
2385
2395
|
description: "Refunding deposit for undelivered materials",
|
|
2386
2396
|
amount: 40
|
|
2387
2397
|
}]
|
|
2388
|
-
}
|
|
2398
|
+
},
|
|
2399
|
+
source: "api"
|
|
2389
2400
|
)
|
|
2390
2401
|
```
|
|
2391
2402
|
</dd>
|
|
@@ -2746,11 +2757,11 @@ client.money_in.validate(
|
|
|
2746
2757
|
<dl>
|
|
2747
2758
|
<dd>
|
|
2748
2759
|
|
|
2749
|
-
|
|
2760
|
+
<Warning>
|
|
2761
|
+
This endpoint is deprecated. Use it only to void transactions originally created with the legacy endpoints. New integrations should use the [Void endpoint](/developers/api-reference/moneyinV2/void-a-transaction), which only works on transactions created with [Make a transaction](/developers/api-reference/moneyinV2/make-a-transaction) or [Authorize](/developers/api-reference/moneyinV2/authorize-a-transaction).
|
|
2762
|
+
</Warning>
|
|
2750
2763
|
|
|
2751
|
-
|
|
2752
|
-
Consider migrating to the [v2 Void endpoint](/developers/api-reference/moneyinV2/void-a-transaction) to take advantage of unified response codes and improved response consistency.
|
|
2753
|
-
</Tip>
|
|
2764
|
+
Cancel a transaction that hasn't been settled yet. Voiding non-captured authorizations prevents future captures. If a transaction has been settled, refund it instead.
|
|
2754
2765
|
</dd>
|
|
2755
2766
|
</dl>
|
|
2756
2767
|
</dd>
|
|
@@ -3088,7 +3099,7 @@ client.money_in.capturev_2(
|
|
|
3088
3099
|
</dl>
|
|
3089
3100
|
</details>
|
|
3090
3101
|
|
|
3091
|
-
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">refundv_2</a>(trans_id) -> Payabli::Types::V2TransactionResponseWrapper</code></summary>
|
|
3102
|
+
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">refundv_2</a>(trans_id, request) -> Payabli::Types::V2TransactionResponseWrapper</code></summary>
|
|
3092
3103
|
<dl>
|
|
3093
3104
|
<dd>
|
|
3094
3105
|
|
|
@@ -3100,9 +3111,13 @@ client.money_in.capturev_2(
|
|
|
3100
3111
|
<dl>
|
|
3101
3112
|
<dd>
|
|
3102
3113
|
|
|
3103
|
-
Give a full refund for a transaction that has settled and send money back to the account holder. To perform a partial refund, see [Partially refund a transaction](developers/api-reference/moneyinV2/partial-refund-a-settled-transaction).
|
|
3114
|
+
Give a full refund for a transaction that has settled and send money back to the account holder. To perform a partial refund, see [Partially refund a transaction](/developers/api-reference/moneyinV2/partial-refund-a-settled-transaction).
|
|
3104
3115
|
|
|
3105
3116
|
This is the v2 version of the refund endpoint, and returns the unified response format. See [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for more information.
|
|
3117
|
+
|
|
3118
|
+
<Note>
|
|
3119
|
+
To refund a split-funded transaction, include split instructions in the request body. Omit the body for a standard refund.
|
|
3120
|
+
</Note>
|
|
3106
3121
|
</dd>
|
|
3107
3122
|
</dl>
|
|
3108
3123
|
</dd>
|
|
@@ -3140,6 +3155,14 @@ client.money_in.refundv_2(trans_id: "10-3ffa27df-b171-44e0-b251-e95fbfc7a723")
|
|
|
3140
3155
|
<dl>
|
|
3141
3156
|
<dd>
|
|
3142
3157
|
|
|
3158
|
+
**request:** `Payabli::Types::RefundV2Request`
|
|
3159
|
+
|
|
3160
|
+
</dd>
|
|
3161
|
+
</dl>
|
|
3162
|
+
|
|
3163
|
+
<dl>
|
|
3164
|
+
<dd>
|
|
3165
|
+
|
|
3143
3166
|
**request_options:** `Payabli::MoneyIn::RequestOptions`
|
|
3144
3167
|
|
|
3145
3168
|
</dd>
|
|
@@ -3152,7 +3175,7 @@ client.money_in.refundv_2(trans_id: "10-3ffa27df-b171-44e0-b251-e95fbfc7a723")
|
|
|
3152
3175
|
</dl>
|
|
3153
3176
|
</details>
|
|
3154
3177
|
|
|
3155
|
-
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">refundv_2_amount</a>(trans_id, amount) -> Payabli::Types::V2TransactionResponseWrapper</code></summary>
|
|
3178
|
+
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">refundv_2_amount</a>(trans_id, amount, request) -> Payabli::Types::V2TransactionResponseWrapper</code></summary>
|
|
3156
3179
|
<dl>
|
|
3157
3180
|
<dd>
|
|
3158
3181
|
|
|
@@ -3164,9 +3187,13 @@ client.money_in.refundv_2(trans_id: "10-3ffa27df-b171-44e0-b251-e95fbfc7a723")
|
|
|
3164
3187
|
<dl>
|
|
3165
3188
|
<dd>
|
|
3166
3189
|
|
|
3167
|
-
Refund a transaction that has settled and send money back to the account holder. If `amount` is
|
|
3190
|
+
Refund a transaction that has settled and send money back to the account holder. If `amount` is set to 0, performs a full refund. When a non-zero `amount` is provided, this endpoint performs a partial refund.
|
|
3168
3191
|
|
|
3169
3192
|
This is the v2 version of the refund endpoint, and returns the unified response format. See [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for more information.
|
|
3193
|
+
|
|
3194
|
+
<Note>
|
|
3195
|
+
To refund a split-funded transaction, include split instructions in the request body. Omit the body for a standard refund.
|
|
3196
|
+
</Note>
|
|
3170
3197
|
</dd>
|
|
3171
3198
|
</dl>
|
|
3172
3199
|
</dd>
|
|
@@ -3207,7 +3234,15 @@ client.money_in.refundv_2_amount(
|
|
|
3207
3234
|
<dl>
|
|
3208
3235
|
<dd>
|
|
3209
3236
|
|
|
3210
|
-
**amount:** `Integer` — Amount to refund from original transaction, minus any service fees charged on the original transaction. If
|
|
3237
|
+
**amount:** `Integer` — Amount to refund from original transaction, minus any service fees charged on the original transaction. If set to 0, performs a full refund.
|
|
3238
|
+
|
|
3239
|
+
</dd>
|
|
3240
|
+
</dl>
|
|
3241
|
+
|
|
3242
|
+
<dl>
|
|
3243
|
+
<dd>
|
|
3244
|
+
|
|
3245
|
+
**request:** `Payabli::Types::RefundV2Request`
|
|
3211
3246
|
|
|
3212
3247
|
</dd>
|
|
3213
3248
|
</dl>
|
|
@@ -3285,6 +3320,96 @@ client.money_in.voidv_2(trans_id: "10-3ffa27df-b171-44e0-b251-e95fbfc7a723")
|
|
|
3285
3320
|
</dl>
|
|
3286
3321
|
|
|
3287
3322
|
|
|
3323
|
+
</dd>
|
|
3324
|
+
</dl>
|
|
3325
|
+
</details>
|
|
3326
|
+
|
|
3327
|
+
## Token
|
|
3328
|
+
<details><summary><code>client.token.<a href="/lib/payabli/token/client.rb">create_server_side_token</a>(request) -> Payabli::Types::PayabliAccessTokenResponse</code></summary>
|
|
3329
|
+
<dl>
|
|
3330
|
+
<dd>
|
|
3331
|
+
|
|
3332
|
+
#### 📝 Description
|
|
3333
|
+
|
|
3334
|
+
<dl>
|
|
3335
|
+
<dd>
|
|
3336
|
+
|
|
3337
|
+
<dl>
|
|
3338
|
+
<dd>
|
|
3339
|
+
|
|
3340
|
+
Exchanges a client ID and client secret for a short-lived Bearer access token using the OAuth2 client-credentials flow. Designed for server-to-server use: the credentials and the returned token stay on your backend. Send the returned `access_token` in the `Authorization` header as `Bearer <access_token>` on subsequent API calls. See the [OAuth authentication guide](/developers/oauth-authentication) for the full flow.
|
|
3341
|
+
</dd>
|
|
3342
|
+
</dl>
|
|
3343
|
+
</dd>
|
|
3344
|
+
</dl>
|
|
3345
|
+
|
|
3346
|
+
#### 🔌 Usage
|
|
3347
|
+
|
|
3348
|
+
<dl>
|
|
3349
|
+
<dd>
|
|
3350
|
+
|
|
3351
|
+
<dl>
|
|
3352
|
+
<dd>
|
|
3353
|
+
|
|
3354
|
+
```ruby
|
|
3355
|
+
client.token.create_server_side_token(
|
|
3356
|
+
client_id: "YOUR_CLIENT_ID",
|
|
3357
|
+
client_secret: "YOUR_CLIENT_SECRET"
|
|
3358
|
+
)
|
|
3359
|
+
```
|
|
3360
|
+
</dd>
|
|
3361
|
+
</dl>
|
|
3362
|
+
</dd>
|
|
3363
|
+
</dl>
|
|
3364
|
+
|
|
3365
|
+
#### ⚙️ Parameters
|
|
3366
|
+
|
|
3367
|
+
<dl>
|
|
3368
|
+
<dd>
|
|
3369
|
+
|
|
3370
|
+
<dl>
|
|
3371
|
+
<dd>
|
|
3372
|
+
|
|
3373
|
+
**client_id:** `String` — The client ID issued for your integration when credentials are provisioned in the Payabli Portal.
|
|
3374
|
+
|
|
3375
|
+
</dd>
|
|
3376
|
+
</dl>
|
|
3377
|
+
|
|
3378
|
+
<dl>
|
|
3379
|
+
<dd>
|
|
3380
|
+
|
|
3381
|
+
**client_secret:** `String` — The client secret issued alongside the client ID. Keep it on your backend and never expose it in client-side code.
|
|
3382
|
+
|
|
3383
|
+
</dd>
|
|
3384
|
+
</dl>
|
|
3385
|
+
|
|
3386
|
+
<dl>
|
|
3387
|
+
<dd>
|
|
3388
|
+
|
|
3389
|
+
**state:** `String` — An optional opaque value echoed back in the response. Use it to correlate the request with its response.
|
|
3390
|
+
|
|
3391
|
+
</dd>
|
|
3392
|
+
</dl>
|
|
3393
|
+
|
|
3394
|
+
<dl>
|
|
3395
|
+
<dd>
|
|
3396
|
+
|
|
3397
|
+
**permissions:** `Internal::Types::Array[String]` — An optional array of permission IDs that scopes the token to a subset of the credential's granted permissions. When omitted, the token carries all permissions granted to the credential.
|
|
3398
|
+
|
|
3399
|
+
</dd>
|
|
3400
|
+
</dl>
|
|
3401
|
+
|
|
3402
|
+
<dl>
|
|
3403
|
+
<dd>
|
|
3404
|
+
|
|
3405
|
+
**request_options:** `Payabli::Token::RequestOptions`
|
|
3406
|
+
|
|
3407
|
+
</dd>
|
|
3408
|
+
</dl>
|
|
3409
|
+
</dd>
|
|
3410
|
+
</dl>
|
|
3411
|
+
|
|
3412
|
+
|
|
3288
3413
|
</dd>
|
|
3289
3414
|
</dl>
|
|
3290
3415
|
</details>
|
|
@@ -3541,7 +3666,7 @@ client.subscription.new_subscription(
|
|
|
3541
3666
|
},
|
|
3542
3667
|
payment_method: {
|
|
3543
3668
|
cardcvv: "123",
|
|
3544
|
-
cardexp: "
|
|
3669
|
+
cardexp: "12/29",
|
|
3545
3670
|
card_holder: "John Cassian",
|
|
3546
3671
|
cardnumber: "4111111111111111",
|
|
3547
3672
|
cardzip: "37615",
|
|
@@ -3908,8 +4033,8 @@ Deletes a file attached to an invoice.
|
|
|
3908
4033
|
|
|
3909
4034
|
```ruby
|
|
3910
4035
|
client.invoice.delete_attached_from_invoice(
|
|
3911
|
-
|
|
3912
|
-
|
|
4036
|
+
id_invoice: 23548884,
|
|
4037
|
+
filename: "0_Bill.pdf"
|
|
3913
4038
|
)
|
|
3914
4039
|
```
|
|
3915
4040
|
</dd>
|
|
@@ -4734,6 +4859,8 @@ client.invoice.get_invoice_pdf(id_invoice: 23548884)
|
|
|
4734
4859
|
<dd>
|
|
4735
4860
|
|
|
4736
4861
|
Generates a payment link for an invoice from the invoice ID.
|
|
4862
|
+
|
|
4863
|
+
The payment page configuration blocks (`logo`, `page`, `paymentMethods`, `review`, `messageBeforePaying`, `paymentButton`, `notes`, `contactUs`, and `settings`) are optional. When you omit a block, Payabli applies a default rather than hiding it. The block is enabled at a fixed display order, so the generated page stays complete and branded. To hide a section, send the block explicitly with `enabled` set to `false`. An explicit value is always honored and is never replaced by a default. For each block's default, see its description in the request body.
|
|
4737
4864
|
</dd>
|
|
4738
4865
|
</dl>
|
|
4739
4866
|
</dd>
|
|
@@ -4903,7 +5030,7 @@ client.payment_link.add_pay_link_from_invoice(
|
|
|
4903
5030
|
<dl>
|
|
4904
5031
|
<dd>
|
|
4905
5032
|
|
|
4906
|
-
**contact_us:** `Payabli::Types::ContactElement` —
|
|
5033
|
+
**contact_us:** `Payabli::Types::ContactElement` — Contact us section of payment link page. If omitted, this block is enabled at display order 11.
|
|
4907
5034
|
|
|
4908
5035
|
</dd>
|
|
4909
5036
|
</dl>
|
|
@@ -4911,7 +5038,7 @@ client.payment_link.add_pay_link_from_invoice(
|
|
|
4911
5038
|
<dl>
|
|
4912
5039
|
<dd>
|
|
4913
5040
|
|
|
4914
|
-
**invoices:** `Payabli::Types::InvoiceElement` — Invoices section of payment link page
|
|
5041
|
+
**invoices:** `Payabli::Types::InvoiceElement` — Invoices section of payment link page. Required. Omitting it returns a `400` error with code `7045`.
|
|
4915
5042
|
|
|
4916
5043
|
</dd>
|
|
4917
5044
|
</dl>
|
|
@@ -4919,7 +5046,7 @@ client.payment_link.add_pay_link_from_invoice(
|
|
|
4919
5046
|
<dl>
|
|
4920
5047
|
<dd>
|
|
4921
5048
|
|
|
4922
|
-
**logo:** `Payabli::Types::Element` — Logo section of payment link page
|
|
5049
|
+
**logo:** `Payabli::Types::Element` — Logo section of payment link page. If omitted, this block is enabled at display order 1, and the logo image is resolved from the paypoint's entry logo.
|
|
4923
5050
|
|
|
4924
5051
|
</dd>
|
|
4925
5052
|
</dl>
|
|
@@ -4927,7 +5054,7 @@ client.payment_link.add_pay_link_from_invoice(
|
|
|
4927
5054
|
<dl>
|
|
4928
5055
|
<dd>
|
|
4929
5056
|
|
|
4930
|
-
**message_before_paying:** `Payabli::Types::LabelElement` — Message section of payment link page
|
|
5057
|
+
**message_before_paying:** `Payabli::Types::LabelElement` — Message section of payment link page. If omitted, this block is enabled at display order 5.
|
|
4931
5058
|
|
|
4932
5059
|
</dd>
|
|
4933
5060
|
</dl>
|
|
@@ -4935,7 +5062,7 @@ client.payment_link.add_pay_link_from_invoice(
|
|
|
4935
5062
|
<dl>
|
|
4936
5063
|
<dd>
|
|
4937
5064
|
|
|
4938
|
-
**notes:** `Payabli::Types::NoteElement` — Notes section of payment link page
|
|
5065
|
+
**notes:** `Payabli::Types::NoteElement` — Notes section of payment link page. If omitted, this block is enabled at display order 10.
|
|
4939
5066
|
|
|
4940
5067
|
</dd>
|
|
4941
5068
|
</dl>
|
|
@@ -4943,7 +5070,7 @@ client.payment_link.add_pay_link_from_invoice(
|
|
|
4943
5070
|
<dl>
|
|
4944
5071
|
<dd>
|
|
4945
5072
|
|
|
4946
|
-
**page:** `Payabli::Types::PageElement` — Page header section of payment link page
|
|
5073
|
+
**page:** `Payabli::Types::PageElement` — Page header section of payment link page. If omitted, this block is enabled at display order 2.
|
|
4947
5074
|
|
|
4948
5075
|
</dd>
|
|
4949
5076
|
</dl>
|
|
@@ -4951,7 +5078,7 @@ client.payment_link.add_pay_link_from_invoice(
|
|
|
4951
5078
|
<dl>
|
|
4952
5079
|
<dd>
|
|
4953
5080
|
|
|
4954
|
-
**payment_button:** `Payabli::Types::LabelElement` — Payment button section of payment link page
|
|
5081
|
+
**payment_button:** `Payabli::Types::LabelElement` — Payment button section of payment link page. If omitted, this block is enabled at display order 6, with the label "Pay Now".
|
|
4955
5082
|
|
|
4956
5083
|
</dd>
|
|
4957
5084
|
</dl>
|
|
@@ -4959,7 +5086,7 @@ client.payment_link.add_pay_link_from_invoice(
|
|
|
4959
5086
|
<dl>
|
|
4960
5087
|
<dd>
|
|
4961
5088
|
|
|
4962
|
-
**payment_methods:** `Payabli::Types::MethodElement` — Payment methods section of payment link page
|
|
5089
|
+
**payment_methods:** `Payabli::Types::MethodElement` — Payment methods section of payment link page. If omitted, this block is enabled at display order 3, with all payment methods enabled except RDC.
|
|
4963
5090
|
|
|
4964
5091
|
</dd>
|
|
4965
5092
|
</dl>
|
|
@@ -4975,7 +5102,7 @@ client.payment_link.add_pay_link_from_invoice(
|
|
|
4975
5102
|
<dl>
|
|
4976
5103
|
<dd>
|
|
4977
5104
|
|
|
4978
|
-
**review:** `Payabli::Types::HeaderElement` — Review section of payment link page
|
|
5105
|
+
**review:** `Payabli::Types::HeaderElement` — Review section of payment link page. If omitted, this block is enabled at display order 4.
|
|
4979
5106
|
|
|
4980
5107
|
</dd>
|
|
4981
5108
|
</dl>
|
|
@@ -4983,7 +5110,7 @@ client.payment_link.add_pay_link_from_invoice(
|
|
|
4983
5110
|
<dl>
|
|
4984
5111
|
<dd>
|
|
4985
5112
|
|
|
4986
|
-
**settings:** `Payabli::Types::PagelinkSetting` — Settings section of payment link page
|
|
5113
|
+
**settings:** `Payabli::Types::PagelinkSetting` — Settings section of payment link page. If omitted, defaults are applied, including page color `#10a0e3` and language `en`.
|
|
4987
5114
|
|
|
4988
5115
|
</dd>
|
|
4989
5116
|
</dl>
|
|
@@ -6075,7 +6202,7 @@ client.token_storage.add_method(
|
|
|
6075
6202
|
method_description: "Primary Visa card",
|
|
6076
6203
|
payment_method: {
|
|
6077
6204
|
cardcvv: "123",
|
|
6078
|
-
cardexp: "
|
|
6205
|
+
cardexp: "12/29",
|
|
6079
6206
|
card_holder: "John Doe",
|
|
6080
6207
|
cardnumber: "4111111111111111",
|
|
6081
6208
|
cardzip: "12345",
|
|
@@ -6285,7 +6412,7 @@ client.token_storage.update_method(
|
|
|
6285
6412
|
fallback_auth: true,
|
|
6286
6413
|
payment_method: {
|
|
6287
6414
|
cardcvv: "123",
|
|
6288
|
-
cardexp: "
|
|
6415
|
+
cardexp: "12/29",
|
|
6289
6416
|
card_holder: "John Doe",
|
|
6290
6417
|
cardnumber: "4111111111111111",
|
|
6291
6418
|
cardzip: "12345",
|
|
@@ -7231,15 +7358,15 @@ Add a payment method domain to an organization or paypoint.
|
|
|
7231
7358
|
|
|
7232
7359
|
```ruby
|
|
7233
7360
|
client.payment_method_domain.add_payment_method_domain(
|
|
7234
|
-
domain_name: "checkout.example.com",
|
|
7235
|
-
entity_id: 109,
|
|
7236
|
-
entity_type: "paypoint",
|
|
7237
7361
|
apple_pay: {
|
|
7238
7362
|
is_enabled: true
|
|
7239
7363
|
},
|
|
7240
7364
|
google_pay: {
|
|
7241
7365
|
is_enabled: true
|
|
7242
|
-
}
|
|
7366
|
+
},
|
|
7367
|
+
domain_name: "checkout.example.com",
|
|
7368
|
+
entity_id: 109,
|
|
7369
|
+
entity_type: "paypoint"
|
|
7243
7370
|
)
|
|
7244
7371
|
```
|
|
7245
7372
|
</dd>
|
|
@@ -12460,6 +12587,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
12460
12587
|
- `payaccountLastfour` (nct, ct)
|
|
12461
12588
|
- `payaccountType` (ne, eq, in, nin)
|
|
12462
12589
|
- `payaccountCurrency` (ne, eq, in, nin)
|
|
12590
|
+
- `binCardType` (eq, ne, in, nin). Filters by card type for card transactions. Accepts `CREDIT`, `DEBIT`, or `PREPAID`. Case-insensitive.
|
|
12463
12591
|
- `customerFirstname` (ct, nct, eq, ne)
|
|
12464
12592
|
- `customerLastname` (ct, nct, eq, ne)
|
|
12465
12593
|
- `customerName` (ct, nct)
|
|
@@ -12660,6 +12788,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
12660
12788
|
- `payaccountLastfour` (nct, ct)
|
|
12661
12789
|
- `payaccountType` (ne, eq, in, nin)
|
|
12662
12790
|
- `payaccountCurrency` (ne, eq, in, nin)
|
|
12791
|
+
- `binCardType` (eq, ne, in, nin). Filters by card type for card transactions. Accepts `CREDIT`, `DEBIT`, or `PREPAID`. Case-insensitive.
|
|
12663
12792
|
- `customerFirstname` (ct, nct, eq, ne)
|
|
12664
12793
|
- `customerLastname` (ct, nct, eq, ne)
|
|
12665
12794
|
- `customerName` (ct, nct)
|
|
@@ -13254,6 +13383,8 @@ List of field names accepted:
|
|
|
13254
13383
|
- `paypointDbaName` (ne, eq, ct, nct)
|
|
13255
13384
|
- `batchNumber` (ne, eq, ct, nct)
|
|
13256
13385
|
- `batchId` (ne, eq, in, nin)
|
|
13386
|
+
- `detailType` (eq, ne, in, nin, ct, nct)
|
|
13387
|
+
- `detailMethod` (eq, ne, in, nin, ct, nct)
|
|
13257
13388
|
|
|
13258
13389
|
</dd>
|
|
13259
13390
|
</dl>
|
|
@@ -13381,6 +13512,8 @@ List of field names accepted:
|
|
|
13381
13512
|
- `paypointDbaName` (ne, eq, ct, nct)
|
|
13382
13513
|
- `batchNumber` (ne, eq, ct, nct)
|
|
13383
13514
|
- `batchId` (ne, eq, in, nin)
|
|
13515
|
+
- `detailType` (eq, ne, in, nin, ct, nct)
|
|
13516
|
+
- `detailMethod` (eq, ne, in, nin, ct, nct)
|
|
13384
13517
|
|
|
13385
13518
|
</dd>
|
|
13386
13519
|
</dl>
|
|
@@ -14950,9 +15083,9 @@ client.notificationlogs.search_notification_logs(
|
|
|
14950
15083
|
page_size: 20,
|
|
14951
15084
|
start_date: "2024-01-01T00:00:00Z",
|
|
14952
15085
|
end_date: "2024-01-31T23:59:59Z",
|
|
14953
|
-
org_id: 123,
|
|
14954
15086
|
notification_event: "ActivatedMerchant",
|
|
14955
|
-
succeeded: true
|
|
15087
|
+
succeeded: true,
|
|
15088
|
+
org_id: 123
|
|
14956
15089
|
)
|
|
14957
15090
|
```
|
|
14958
15091
|
</dd>
|
|
@@ -15266,8 +15399,8 @@ Register a cloud device to an entrypoint. See [Devices Quickstart](/developers/d
|
|
|
15266
15399
|
```ruby
|
|
15267
15400
|
client.cloud.add_device(
|
|
15268
15401
|
entry: "8cfec329267",
|
|
15269
|
-
|
|
15270
|
-
|
|
15402
|
+
description: "Front Desk POS",
|
|
15403
|
+
registration_code: "YS7DS5"
|
|
15271
15404
|
)
|
|
15272
15405
|
```
|
|
15273
15406
|
</dd>
|
|
@@ -15361,8 +15494,8 @@ Remove a cloud device from an entrypoint.
|
|
|
15361
15494
|
|
|
15362
15495
|
```ruby
|
|
15363
15496
|
client.cloud.remove_device(
|
|
15364
|
-
|
|
15365
|
-
|
|
15497
|
+
entry: "8cfec329267",
|
|
15498
|
+
device_id: "499585-389fj484-3jcj8hj3"
|
|
15366
15499
|
)
|
|
15367
15500
|
```
|
|
15368
15501
|
</dd>
|
|
@@ -15434,8 +15567,8 @@ Retrieve the registration history for a device.
|
|
|
15434
15567
|
|
|
15435
15568
|
```ruby
|
|
15436
15569
|
client.cloud.history_device(
|
|
15437
|
-
|
|
15438
|
-
|
|
15570
|
+
entry: "8cfec329267",
|
|
15571
|
+
device_id: "499585-389fj484-3jcj8hj3"
|
|
15439
15572
|
)
|
|
15440
15573
|
```
|
|
15441
15574
|
</dd>
|
|
@@ -16556,7 +16689,7 @@ client.boarding.get_by_template_id_link_application(template_id: 80)
|
|
|
16556
16689
|
<dl>
|
|
16557
16690
|
<dd>
|
|
16558
16691
|
|
|
16559
|
-
**template_id:** `Integer` — The boarding template ID. You can find this at the end of the boarding template URL in
|
|
16692
|
+
**template_id:** `Integer` — The boarding template ID. You can find this at the end of the boarding template URL in the Payabli Portal. Example: `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`. Here, the template ID is `80`.
|
|
16560
16693
|
|
|
16561
16694
|
</dd>
|
|
16562
16695
|
</dl>
|
|
@@ -17198,7 +17331,7 @@ client.templates.delete_template(template_id: 80)
|
|
|
17198
17331
|
<dl>
|
|
17199
17332
|
<dd>
|
|
17200
17333
|
|
|
17201
|
-
**template_id:** `Integer` — The boarding template ID. You can find this at the end of the boarding template URL in
|
|
17334
|
+
**template_id:** `Integer` — The boarding template ID. You can find this at the end of the boarding template URL in the Payabli Portal. Example: `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`. Here, the template ID is `80`.
|
|
17202
17335
|
|
|
17203
17336
|
</dd>
|
|
17204
17337
|
</dl>
|
|
@@ -17246,8 +17379,8 @@ Generates a boarding link from a boarding template.
|
|
|
17246
17379
|
|
|
17247
17380
|
```ruby
|
|
17248
17381
|
client.templates.getlink_template(
|
|
17249
|
-
|
|
17250
|
-
|
|
17382
|
+
template_id: 80,
|
|
17383
|
+
ignore_empty: true
|
|
17251
17384
|
)
|
|
17252
17385
|
```
|
|
17253
17386
|
</dd>
|
|
@@ -17263,7 +17396,7 @@ client.templates.getlink_template(
|
|
|
17263
17396
|
<dl>
|
|
17264
17397
|
<dd>
|
|
17265
17398
|
|
|
17266
|
-
**template_id:** `Integer` — The boarding template ID. You can find this at the end of the boarding template URL in
|
|
17399
|
+
**template_id:** `Integer` — The boarding template ID. You can find this at the end of the boarding template URL in the Payabli Portal. Example: `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`. Here, the template ID is `80`.
|
|
17267
17400
|
|
|
17268
17401
|
</dd>
|
|
17269
17402
|
</dl>
|
|
@@ -17333,7 +17466,7 @@ client.templates.get_template(template_id: 80)
|
|
|
17333
17466
|
<dl>
|
|
17334
17467
|
<dd>
|
|
17335
17468
|
|
|
17336
|
-
**template_id:** `Integer` — The boarding template ID. You can find this at the end of the boarding template URL in
|
|
17469
|
+
**template_id:** `Integer` — The boarding template ID. You can find this at the end of the boarding template URL in the Payabli Portal. Example: `https://partner-sandbox.payabli.com/myorganization/boarding/edittemplate/80`. Here, the template ID is `80`.
|
|
17337
17470
|
|
|
17338
17471
|
</dd>
|
|
17339
17472
|
</dl>
|
|
@@ -17694,8 +17827,8 @@ Export batch details for a paypoint. Use filters to limit results.
|
|
|
17694
17827
|
|
|
17695
17828
|
```ruby
|
|
17696
17829
|
client.export.export_batch_details(
|
|
17697
|
-
entry: "8cfec329267",
|
|
17698
17830
|
format: "csv",
|
|
17831
|
+
entry: "8cfec329267",
|
|
17699
17832
|
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
17700
17833
|
from_record: 251,
|
|
17701
17834
|
limit_record: 1000
|
|
@@ -18046,8 +18179,8 @@ Export a list of batches for an entrypoint. Use filters to limit results.
|
|
|
18046
18179
|
|
|
18047
18180
|
```ruby
|
|
18048
18181
|
client.export.export_batches(
|
|
18049
|
-
entry: "8cfec329267",
|
|
18050
18182
|
format: "csv",
|
|
18183
|
+
entry: "8cfec329267",
|
|
18051
18184
|
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
18052
18185
|
from_record: 251,
|
|
18053
18186
|
limit_record: 1000
|
|
@@ -18376,8 +18509,8 @@ Export a list of money out batches for a paypoint. Use filters to limit results.
|
|
|
18376
18509
|
|
|
18377
18510
|
```ruby
|
|
18378
18511
|
client.export.export_batches_out(
|
|
18379
|
-
entry: "8cfec329267",
|
|
18380
18512
|
format: "csv",
|
|
18513
|
+
entry: "8cfec329267",
|
|
18381
18514
|
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
18382
18515
|
from_record: 251,
|
|
18383
18516
|
limit_record: 1000
|
|
@@ -18668,8 +18801,8 @@ Export a list of bills for an entrypoint. Use filters to limit results.
|
|
|
18668
18801
|
|
|
18669
18802
|
```ruby
|
|
18670
18803
|
client.export.export_bills(
|
|
18671
|
-
entry: "8cfec329267",
|
|
18672
18804
|
format: "csv",
|
|
18805
|
+
entry: "8cfec329267",
|
|
18673
18806
|
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
18674
18807
|
from_record: 251,
|
|
18675
18808
|
limit_record: 1000
|
|
@@ -18996,8 +19129,8 @@ Export a list of chargebacks and ACH returns for an entrypoint. Use filters to l
|
|
|
18996
19129
|
|
|
18997
19130
|
```ruby
|
|
18998
19131
|
client.export.export_chargebacks(
|
|
18999
|
-
entry: "8cfec329267",
|
|
19000
19132
|
format: "csv",
|
|
19133
|
+
entry: "8cfec329267",
|
|
19001
19134
|
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
19002
19135
|
from_record: 251,
|
|
19003
19136
|
limit_record: 1000
|
|
@@ -19366,8 +19499,8 @@ Export a list of customers for an entrypoint. Use filters to limit results.
|
|
|
19366
19499
|
|
|
19367
19500
|
```ruby
|
|
19368
19501
|
client.export.export_customers(
|
|
19369
|
-
entry: "8cfec329267",
|
|
19370
19502
|
format: "csv",
|
|
19503
|
+
entry: "8cfec329267",
|
|
19371
19504
|
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
19372
19505
|
from_record: 251,
|
|
19373
19506
|
limit_record: 1000
|
|
@@ -19722,8 +19855,8 @@ Export list of invoices for an entrypoint. Use filters to limit results.
|
|
|
19722
19855
|
|
|
19723
19856
|
```ruby
|
|
19724
19857
|
client.export.export_invoices(
|
|
19725
|
-
entry: "8cfec329267",
|
|
19726
19858
|
format: "csv",
|
|
19859
|
+
entry: "8cfec329267",
|
|
19727
19860
|
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
19728
19861
|
from_record: 251,
|
|
19729
19862
|
limit_record: 1000
|
|
@@ -20261,8 +20394,8 @@ Export a list of payouts and their statuses for an entrypoint. Use filters to li
|
|
|
20261
20394
|
|
|
20262
20395
|
```ruby
|
|
20263
20396
|
client.export.export_payout(
|
|
20264
|
-
entry: "8cfec329267",
|
|
20265
20397
|
format: "csv",
|
|
20398
|
+
entry: "8cfec329267",
|
|
20266
20399
|
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
20267
20400
|
from_record: 251,
|
|
20268
20401
|
limit_record: 1000
|
|
@@ -20749,8 +20882,8 @@ Export a list of settled transactions for an entrypoint. Use filters to limit re
|
|
|
20749
20882
|
|
|
20750
20883
|
```ruby
|
|
20751
20884
|
client.export.export_settlements(
|
|
20752
|
-
entry: "8cfec329267",
|
|
20753
20885
|
format: "csv",
|
|
20886
|
+
entry: "8cfec329267",
|
|
20754
20887
|
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
20755
20888
|
from_record: 251,
|
|
20756
20889
|
limit_record: 1000
|
|
@@ -21117,8 +21250,8 @@ Export a list of subscriptions for an entrypoint. Use filters to limit results.
|
|
|
21117
21250
|
|
|
21118
21251
|
```ruby
|
|
21119
21252
|
client.export.export_subscriptions(
|
|
21120
|
-
entry: "8cfec329267",
|
|
21121
21253
|
format: "csv",
|
|
21254
|
+
entry: "8cfec329267",
|
|
21122
21255
|
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
21123
21256
|
from_record: 251,
|
|
21124
21257
|
limit_record: 1000
|
|
@@ -21489,8 +21622,8 @@ Export a list of transactions for an entrypoint in a file in XLSX or CSV format.
|
|
|
21489
21622
|
|
|
21490
21623
|
```ruby
|
|
21491
21624
|
client.export.export_transactions(
|
|
21492
|
-
entry: "8cfec329267",
|
|
21493
21625
|
format: "csv",
|
|
21626
|
+
entry: "8cfec329267",
|
|
21494
21627
|
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
21495
21628
|
from_record: 251,
|
|
21496
21629
|
limit_record: 1000
|
|
@@ -21869,8 +22002,8 @@ Export a list of transfer details for an entrypoint. Use filters to limit result
|
|
|
21869
22002
|
|
|
21870
22003
|
```ruby
|
|
21871
22004
|
client.export.export_transfer_details(
|
|
21872
|
-
entry: "8cfec329267",
|
|
21873
22005
|
format: "csv",
|
|
22006
|
+
entry: "8cfec329267",
|
|
21874
22007
|
transfer_id: 4521,
|
|
21875
22008
|
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
21876
22009
|
from_record: 251,
|
|
@@ -22196,8 +22329,8 @@ Export a list of vendors for an entrypoint. Use filters to limit results.
|
|
|
22196
22329
|
|
|
22197
22330
|
```ruby
|
|
22198
22331
|
client.export.export_vendors(
|
|
22199
|
-
entry: "8cfec329267",
|
|
22200
22332
|
format: "csv",
|
|
22333
|
+
entry: "8cfec329267",
|
|
22201
22334
|
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
22202
22335
|
from_record: 251,
|
|
22203
22336
|
limit_record: 1000
|
|
@@ -23448,12 +23581,12 @@ Retrieves the basic statistics for an organization or a paypoint, for a given ti
|
|
|
23448
23581
|
|
|
23449
23582
|
```ruby
|
|
23450
23583
|
client.statistic.basic_stats(
|
|
23451
|
-
|
|
23584
|
+
mode: "custom",
|
|
23452
23585
|
freq: "m",
|
|
23453
23586
|
level: 2,
|
|
23454
|
-
|
|
23455
|
-
|
|
23456
|
-
|
|
23587
|
+
entry_id: 1000000,
|
|
23588
|
+
end_date: "2025-11-30",
|
|
23589
|
+
start_date: "2025-11-01"
|
|
23457
23590
|
)
|
|
23458
23591
|
```
|
|
23459
23592
|
</dd>
|
|
@@ -23607,9 +23740,9 @@ Retrieves the basic statistics for a customer for a specific time period, groupe
|
|
|
23607
23740
|
|
|
23608
23741
|
```ruby
|
|
23609
23742
|
client.statistic.customer_basic_stats(
|
|
23610
|
-
|
|
23743
|
+
mode: "ytd",
|
|
23611
23744
|
freq: "m",
|
|
23612
|
-
|
|
23745
|
+
customer_id: 4440
|
|
23613
23746
|
)
|
|
23614
23747
|
```
|
|
23615
23748
|
</dd>
|
|
@@ -23664,7 +23797,7 @@ For example, `w` groups the results by week.
|
|
|
23664
23797
|
<dl>
|
|
23665
23798
|
<dd>
|
|
23666
23799
|
|
|
23667
|
-
**customer_id:** `Integer` — Payabli-generated customer ID. Maps to "Customer ID" column in
|
|
23800
|
+
**customer_id:** `Integer` — Payabli-generated customer ID. Maps to "Customer ID" column in the Payabli Portal.
|
|
23668
23801
|
|
|
23669
23802
|
</dd>
|
|
23670
23803
|
</dl>
|
|
@@ -23720,9 +23853,9 @@ Retrieves the subscription statistics for a given interval for a paypoint or org
|
|
|
23720
23853
|
|
|
23721
23854
|
```ruby
|
|
23722
23855
|
client.statistic.sub_stats(
|
|
23723
|
-
entry_id: 1000000,
|
|
23724
23856
|
interval: "30",
|
|
23725
|
-
level: 2
|
|
23857
|
+
level: 2,
|
|
23858
|
+
entry_id: 1000000
|
|
23726
23859
|
)
|
|
23727
23860
|
```
|
|
23728
23861
|
</dd>
|
|
@@ -23822,9 +23955,9 @@ Retrieve the basic statistics about a vendor for a given time period, grouped by
|
|
|
23822
23955
|
|
|
23823
23956
|
```ruby
|
|
23824
23957
|
client.statistic.vendor_basic_stats(
|
|
23958
|
+
mode: "ytd",
|
|
23825
23959
|
freq: "m",
|
|
23826
|
-
id_vendor: 1
|
|
23827
|
-
mode: "ytd"
|
|
23960
|
+
id_vendor: 1
|
|
23828
23961
|
)
|
|
23829
23962
|
```
|
|
23830
23963
|
</dd>
|
|
@@ -25049,9 +25182,9 @@ Resends the MFA code to the user via the selected MFA mode (email or SMS).
|
|
|
25049
25182
|
|
|
25050
25183
|
```ruby
|
|
25051
25184
|
client.user.resend_mfa_code(
|
|
25185
|
+
usrname: "usrname",
|
|
25052
25186
|
entry: "8cfec329267",
|
|
25053
|
-
entry_type: 1
|
|
25054
|
-
usrname: "usrname"
|
|
25187
|
+
entry_type: 1
|
|
25055
25188
|
)
|
|
25056
25189
|
```
|
|
25057
25190
|
</dd>
|
|
@@ -25447,12 +25580,12 @@ client.vendor.enrich_vendor(
|
|
|
25447
25580
|
vendor_id: 456,
|
|
25448
25581
|
scope: ["invoice_scan"],
|
|
25449
25582
|
apply_enrichment_data: false,
|
|
25450
|
-
fallback_method: "check",
|
|
25451
25583
|
invoice_file: {
|
|
25452
25584
|
ftype: "pdf",
|
|
25453
25585
|
filename: "invoice-2026-001.pdf",
|
|
25454
25586
|
f_content: "<base64-encoded-pdf>"
|
|
25455
|
-
}
|
|
25587
|
+
},
|
|
25588
|
+
fallback_method: "check"
|
|
25456
25589
|
)
|
|
25457
25590
|
```
|
|
25458
25591
|
</dd>
|
|
@@ -25500,7 +25633,7 @@ client.vendor.enrich_vendor(
|
|
|
25500
25633
|
<dl>
|
|
25501
25634
|
<dd>
|
|
25502
25635
|
|
|
25503
|
-
**schedule_call_if_needed:** `Internal::Types::Boolean` — When `true`,
|
|
25636
|
+
**schedule_call_if_needed:** `Internal::Types::Boolean` — When `true`, Payabli schedules an AI outreach call to the vendor if the enrichment stages return insufficient payment acceptance info. The call collects the vendor's preferred payment method and contact email. This is the third enrichment stage and is opt-in at the org level. See the schedule outreach call endpoint for behavior and requirements.
|
|
25504
25637
|
|
|
25505
25638
|
</dd>
|
|
25506
25639
|
</dl>
|
|
@@ -25544,8 +25677,7 @@ client.vendor.enrich_vendor(
|
|
|
25544
25677
|
</dl>
|
|
25545
25678
|
</details>
|
|
25546
25679
|
|
|
25547
|
-
|
|
25548
|
-
<details><summary><code>client.ghost_card.<a href="/lib/payabli/ghost_card/client.rb">create_ghost_card</a>(entry, request) -> Payabli::Types::CreateGhostCardResponse</code></summary>
|
|
25680
|
+
<details><summary><code>client.vendor.<a href="/lib/payabli/vendor/client.rb">schedule_enrichment_call</a>(entry, request) -> Payabli::Types::VendorScheduleCallResponse</code></summary>
|
|
25549
25681
|
<dl>
|
|
25550
25682
|
<dd>
|
|
25551
25683
|
|
|
@@ -25557,11 +25689,7 @@ client.vendor.enrich_vendor(
|
|
|
25557
25689
|
<dl>
|
|
25558
25690
|
<dd>
|
|
25559
25691
|
|
|
25560
|
-
|
|
25561
|
-
|
|
25562
|
-
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.
|
|
25563
|
-
|
|
25564
|
-
Only one ghost card can exist per vendor per paypoint. To issue a new card to the same vendor, cancel the existing card first.
|
|
25692
|
+
Schedules an AI outreach call to a vendor to collect their preferred payment method and contact email. This is the third enrichment stage. Calls are scheduled for the next business day at around 9 AM in the vendor's timezone, with retries on no-answer and a fallback payment method applied when retries are exhausted. This feature is opt-in at the org level. Contact your Payabli representative to enable it, provision a phone number, and discuss pricing.
|
|
25565
25693
|
</dd>
|
|
25566
25694
|
</dl>
|
|
25567
25695
|
</dd>
|
|
@@ -25576,23 +25704,15 @@ Only one ghost card can exist per vendor per paypoint. To issue a new card to th
|
|
|
25576
25704
|
<dd>
|
|
25577
25705
|
|
|
25578
25706
|
```ruby
|
|
25579
|
-
client.
|
|
25707
|
+
client.vendor.schedule_enrichment_call(
|
|
25580
25708
|
entry: "8cfec329267",
|
|
25581
25709
|
vendor_id: 456,
|
|
25582
|
-
|
|
25583
|
-
|
|
25584
|
-
|
|
25585
|
-
|
|
25586
|
-
|
|
25587
|
-
|
|
25588
|
-
billing_cycle_day: "1",
|
|
25589
|
-
daily_transaction_count: 5,
|
|
25590
|
-
daily_amount_limit: 200,
|
|
25591
|
-
transaction_amount_limit: 100,
|
|
25592
|
-
mcc: "5411",
|
|
25593
|
-
tcc: "R",
|
|
25594
|
-
misc_1: "PO-98765",
|
|
25595
|
-
misc_2: "Dept-Finance"
|
|
25710
|
+
phone: "5555550200",
|
|
25711
|
+
enrichment_id: "enrich-3890-a1b2c3d4",
|
|
25712
|
+
bill_id: 54323,
|
|
25713
|
+
fallback_method: "check",
|
|
25714
|
+
max_retries: 3,
|
|
25715
|
+
timezone: "America/New_York"
|
|
25596
25716
|
)
|
|
25597
25717
|
```
|
|
25598
25718
|
</dd>
|
|
@@ -25608,7 +25728,7 @@ client.ghost_card.create_ghost_card(
|
|
|
25608
25728
|
<dl>
|
|
25609
25729
|
<dd>
|
|
25610
25730
|
|
|
25611
|
-
**entry:** `String` —
|
|
25731
|
+
**entry:** `String` — Entrypoint identifier.
|
|
25612
25732
|
|
|
25613
25733
|
</dd>
|
|
25614
25734
|
</dl>
|
|
@@ -25616,7 +25736,7 @@ client.ghost_card.create_ghost_card(
|
|
|
25616
25736
|
<dl>
|
|
25617
25737
|
<dd>
|
|
25618
25738
|
|
|
25619
|
-
**vendor_id:** `Integer` — ID of the vendor
|
|
25739
|
+
**vendor_id:** `Integer` — ID of the vendor to call. Must be active and belong to the entrypoint in the path.
|
|
25620
25740
|
|
|
25621
25741
|
</dd>
|
|
25622
25742
|
</dl>
|
|
@@ -25624,7 +25744,7 @@ client.ghost_card.create_ghost_card(
|
|
|
25624
25744
|
<dl>
|
|
25625
25745
|
<dd>
|
|
25626
25746
|
|
|
25627
|
-
**
|
|
25747
|
+
**phone:** `String` — Vendor phone number to call, digits only. Optional. When omitted, Payabli uses the phone number on the vendor's record. If the vendor has no phone on record, the request returns an error.
|
|
25628
25748
|
|
|
25629
25749
|
</dd>
|
|
25630
25750
|
</dl>
|
|
@@ -25632,7 +25752,7 @@ client.ghost_card.create_ghost_card(
|
|
|
25632
25752
|
<dl>
|
|
25633
25753
|
<dd>
|
|
25634
25754
|
|
|
25635
|
-
**
|
|
25755
|
+
**enrichment_id:** `String` — ID of the originating enrichment run to associate with this call. Optional. When omitted, Payabli generates a standalone call schedule and skips the enrichment lookup. The bill due-date check only runs when both `enrichmentId` and `billId` are supplied.
|
|
25636
25756
|
|
|
25637
25757
|
</dd>
|
|
25638
25758
|
</dl>
|
|
@@ -25640,7 +25760,7 @@ client.ghost_card.create_ghost_card(
|
|
|
25640
25760
|
<dl>
|
|
25641
25761
|
<dd>
|
|
25642
25762
|
|
|
25643
|
-
**
|
|
25763
|
+
**bill_id:** `Integer` — Bill ID used for the due-date check. When the bill is due in fewer than three days, the call is skipped and the fallback method is applied. Only evaluated when `enrichmentId` is also supplied.
|
|
25644
25764
|
|
|
25645
25765
|
</dd>
|
|
25646
25766
|
</dl>
|
|
@@ -25648,7 +25768,7 @@ client.ghost_card.create_ghost_card(
|
|
|
25648
25768
|
<dl>
|
|
25649
25769
|
<dd>
|
|
25650
25770
|
|
|
25651
|
-
**
|
|
25771
|
+
**fallback_method:** `String` — Payment method to apply to the vendor record if the call can't determine a preference or all retries are exhausted. Values are `check` (the default) or `managed`.
|
|
25652
25772
|
|
|
25653
25773
|
</dd>
|
|
25654
25774
|
</dl>
|
|
@@ -25656,7 +25776,7 @@ client.ghost_card.create_ghost_card(
|
|
|
25656
25776
|
<dl>
|
|
25657
25777
|
<dd>
|
|
25658
25778
|
|
|
25659
|
-
**
|
|
25779
|
+
**max_retries:** `Integer` — Number of times to retry the call if the vendor doesn't answer. Defaults to 3. Maximum is 5. The get outreach call status response reports this value as `maxAttempts`.
|
|
25660
25780
|
|
|
25661
25781
|
</dd>
|
|
25662
25782
|
</dl>
|
|
@@ -25664,7 +25784,7 @@ client.ghost_card.create_ghost_card(
|
|
|
25664
25784
|
<dl>
|
|
25665
25785
|
<dd>
|
|
25666
25786
|
|
|
25667
|
-
**
|
|
25787
|
+
**timezone:** `String` — IANA timezone identifier used to schedule the call in the vendor's local time. Defaults to `America/New_York`.
|
|
25668
25788
|
|
|
25669
25789
|
</dd>
|
|
25670
25790
|
</dl>
|
|
@@ -25672,7 +25792,7 @@ client.ghost_card.create_ghost_card(
|
|
|
25672
25792
|
<dl>
|
|
25673
25793
|
<dd>
|
|
25674
25794
|
|
|
25675
|
-
**
|
|
25795
|
+
**send_now:** `Internal::Types::Boolean` — When `true`, dispatches the call immediately and bypasses the business-hours window and the bill due-date check. Defaults to `false`.
|
|
25676
25796
|
|
|
25677
25797
|
</dd>
|
|
25678
25798
|
</dl>
|
|
@@ -25680,40 +25800,250 @@ client.ghost_card.create_ghost_card(
|
|
|
25680
25800
|
<dl>
|
|
25681
25801
|
<dd>
|
|
25682
25802
|
|
|
25683
|
-
**
|
|
25803
|
+
**request_options:** `Payabli::Vendor::RequestOptions`
|
|
25684
25804
|
|
|
25685
25805
|
</dd>
|
|
25686
25806
|
</dl>
|
|
25807
|
+
</dd>
|
|
25808
|
+
</dl>
|
|
25687
25809
|
|
|
25688
|
-
<dl>
|
|
25689
|
-
<dd>
|
|
25690
25810
|
|
|
25691
|
-
**daily_transaction_count:** `Integer` — Maximum number of transactions allowed per day.
|
|
25692
|
-
|
|
25693
25811
|
</dd>
|
|
25694
25812
|
</dl>
|
|
25813
|
+
</details>
|
|
25695
25814
|
|
|
25815
|
+
<details><summary><code>client.vendor.<a href="/lib/payabli/vendor/client.rb">get_enrichment_call_status</a>(id_vendor) -> Payabli::Types::VendorCallStatusResponse</code></summary>
|
|
25696
25816
|
<dl>
|
|
25697
25817
|
<dd>
|
|
25698
25818
|
|
|
25699
|
-
|
|
25700
|
-
|
|
25701
|
-
</dd>
|
|
25702
|
-
</dl>
|
|
25819
|
+
#### 📝 Description
|
|
25703
25820
|
|
|
25704
25821
|
<dl>
|
|
25705
25822
|
<dd>
|
|
25706
25823
|
|
|
25707
|
-
**transaction_amount_limit:** `Integer` — Maximum spend allowed per single transaction.
|
|
25708
|
-
|
|
25709
|
-
</dd>
|
|
25710
|
-
</dl>
|
|
25711
|
-
|
|
25712
25824
|
<dl>
|
|
25713
25825
|
<dd>
|
|
25714
25826
|
|
|
25715
|
-
|
|
25716
|
-
|
|
25827
|
+
Returns the latest AI outreach call activity for a vendor. The response is a composite object with a `state` discriminator (`none`, `scheduled`, `successful`, or `failed`); the block that matches the current state is populated. When the vendor has no call activity, `state` is `none` and the response returns HTTP 200.
|
|
25828
|
+
</dd>
|
|
25829
|
+
</dl>
|
|
25830
|
+
</dd>
|
|
25831
|
+
</dl>
|
|
25832
|
+
|
|
25833
|
+
#### 🔌 Usage
|
|
25834
|
+
|
|
25835
|
+
<dl>
|
|
25836
|
+
<dd>
|
|
25837
|
+
|
|
25838
|
+
<dl>
|
|
25839
|
+
<dd>
|
|
25840
|
+
|
|
25841
|
+
```ruby
|
|
25842
|
+
client.vendor.get_enrichment_call_status(id_vendor: 456)
|
|
25843
|
+
```
|
|
25844
|
+
</dd>
|
|
25845
|
+
</dl>
|
|
25846
|
+
</dd>
|
|
25847
|
+
</dl>
|
|
25848
|
+
|
|
25849
|
+
#### ⚙️ Parameters
|
|
25850
|
+
|
|
25851
|
+
<dl>
|
|
25852
|
+
<dd>
|
|
25853
|
+
|
|
25854
|
+
<dl>
|
|
25855
|
+
<dd>
|
|
25856
|
+
|
|
25857
|
+
**id_vendor:** `Integer` — ID of the vendor to read call status for.
|
|
25858
|
+
|
|
25859
|
+
</dd>
|
|
25860
|
+
</dl>
|
|
25861
|
+
|
|
25862
|
+
<dl>
|
|
25863
|
+
<dd>
|
|
25864
|
+
|
|
25865
|
+
**request_options:** `Payabli::Vendor::RequestOptions`
|
|
25866
|
+
|
|
25867
|
+
</dd>
|
|
25868
|
+
</dl>
|
|
25869
|
+
</dd>
|
|
25870
|
+
</dl>
|
|
25871
|
+
|
|
25872
|
+
|
|
25873
|
+
</dd>
|
|
25874
|
+
</dl>
|
|
25875
|
+
</details>
|
|
25876
|
+
|
|
25877
|
+
## GhostCard
|
|
25878
|
+
<details><summary><code>client.ghost_card.<a href="/lib/payabli/ghost_card/client.rb">create_ghost_card</a>(entry, request) -> Payabli::Types::CreateGhostCardResponse</code></summary>
|
|
25879
|
+
<dl>
|
|
25880
|
+
<dd>
|
|
25881
|
+
|
|
25882
|
+
#### 📝 Description
|
|
25883
|
+
|
|
25884
|
+
<dl>
|
|
25885
|
+
<dd>
|
|
25886
|
+
|
|
25887
|
+
<dl>
|
|
25888
|
+
<dd>
|
|
25889
|
+
|
|
25890
|
+
Creates a ghost card, a multi-use virtual debit card issued to a vendor for recurring or discretionary spend.
|
|
25891
|
+
|
|
25892
|
+
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.
|
|
25893
|
+
|
|
25894
|
+
Only one ghost card can exist per vendor per paypoint. To issue a new card to the same vendor, cancel the existing card first.
|
|
25895
|
+
</dd>
|
|
25896
|
+
</dl>
|
|
25897
|
+
</dd>
|
|
25898
|
+
</dl>
|
|
25899
|
+
|
|
25900
|
+
#### 🔌 Usage
|
|
25901
|
+
|
|
25902
|
+
<dl>
|
|
25903
|
+
<dd>
|
|
25904
|
+
|
|
25905
|
+
<dl>
|
|
25906
|
+
<dd>
|
|
25907
|
+
|
|
25908
|
+
```ruby
|
|
25909
|
+
client.ghost_card.create_ghost_card(
|
|
25910
|
+
entry: "8cfec329267",
|
|
25911
|
+
vendor_id: 456,
|
|
25912
|
+
expense_limit: 500,
|
|
25913
|
+
amount: 500,
|
|
25914
|
+
max_number_of_uses: 3,
|
|
25915
|
+
exact_amount: false,
|
|
25916
|
+
expense_limit_period: "monthly",
|
|
25917
|
+
billing_cycle: "monthly",
|
|
25918
|
+
billing_cycle_day: "1",
|
|
25919
|
+
daily_transaction_count: 5,
|
|
25920
|
+
daily_amount_limit: 200,
|
|
25921
|
+
transaction_amount_limit: 100,
|
|
25922
|
+
mcc: "5411",
|
|
25923
|
+
tcc: "R",
|
|
25924
|
+
misc_1: "PO-98765",
|
|
25925
|
+
misc_2: "Dept-Finance"
|
|
25926
|
+
)
|
|
25927
|
+
```
|
|
25928
|
+
</dd>
|
|
25929
|
+
</dl>
|
|
25930
|
+
</dd>
|
|
25931
|
+
</dl>
|
|
25932
|
+
|
|
25933
|
+
#### ⚙️ Parameters
|
|
25934
|
+
|
|
25935
|
+
<dl>
|
|
25936
|
+
<dd>
|
|
25937
|
+
|
|
25938
|
+
<dl>
|
|
25939
|
+
<dd>
|
|
25940
|
+
|
|
25941
|
+
**entry:** `String` — The entity's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
25942
|
+
|
|
25943
|
+
</dd>
|
|
25944
|
+
</dl>
|
|
25945
|
+
|
|
25946
|
+
<dl>
|
|
25947
|
+
<dd>
|
|
25948
|
+
|
|
25949
|
+
**vendor_id:** `Integer` — ID of the vendor who receives the card. The vendor must belong to the paypoint and have an active status.
|
|
25950
|
+
|
|
25951
|
+
</dd>
|
|
25952
|
+
</dl>
|
|
25953
|
+
|
|
25954
|
+
<dl>
|
|
25955
|
+
<dd>
|
|
25956
|
+
|
|
25957
|
+
**expense_limit:** `Integer` — Spending limit for the card. Must be greater than `0` and can't exceed the paypoint's configured payout credit limit.
|
|
25958
|
+
|
|
25959
|
+
</dd>
|
|
25960
|
+
</dl>
|
|
25961
|
+
|
|
25962
|
+
<dl>
|
|
25963
|
+
<dd>
|
|
25964
|
+
|
|
25965
|
+
**expiration_date:** `String` — Requested expiration date for the card. If not provided, defaults to 30 days from creation.
|
|
25966
|
+
|
|
25967
|
+
</dd>
|
|
25968
|
+
</dl>
|
|
25969
|
+
|
|
25970
|
+
<dl>
|
|
25971
|
+
<dd>
|
|
25972
|
+
|
|
25973
|
+
**amount:** `Integer` — Initial load amount for the card.
|
|
25974
|
+
|
|
25975
|
+
</dd>
|
|
25976
|
+
</dl>
|
|
25977
|
+
|
|
25978
|
+
<dl>
|
|
25979
|
+
<dd>
|
|
25980
|
+
|
|
25981
|
+
**max_number_of_uses:** `Integer` — Maximum number of times the card can be used. Ignored and set to `1` when `exactAmount` is `true`.
|
|
25982
|
+
|
|
25983
|
+
</dd>
|
|
25984
|
+
</dl>
|
|
25985
|
+
|
|
25986
|
+
<dl>
|
|
25987
|
+
<dd>
|
|
25988
|
+
|
|
25989
|
+
**exact_amount:** `Internal::Types::Boolean` — When `true`, restricts the card to a single use. `maxNumberOfUses` is automatically set to `1` regardless of any other value provided.
|
|
25990
|
+
|
|
25991
|
+
</dd>
|
|
25992
|
+
</dl>
|
|
25993
|
+
|
|
25994
|
+
<dl>
|
|
25995
|
+
<dd>
|
|
25996
|
+
|
|
25997
|
+
**expense_limit_period:** `String` — Time period over which `expenseLimit` applies (for example, `monthly` or `weekly`).
|
|
25998
|
+
|
|
25999
|
+
</dd>
|
|
26000
|
+
</dl>
|
|
26001
|
+
|
|
26002
|
+
<dl>
|
|
26003
|
+
<dd>
|
|
26004
|
+
|
|
26005
|
+
**billing_cycle:** `String` — Billing cycle identifier.
|
|
26006
|
+
|
|
26007
|
+
</dd>
|
|
26008
|
+
</dl>
|
|
26009
|
+
|
|
26010
|
+
<dl>
|
|
26011
|
+
<dd>
|
|
26012
|
+
|
|
26013
|
+
**billing_cycle_day:** `String` — Day within the billing cycle.
|
|
26014
|
+
|
|
26015
|
+
</dd>
|
|
26016
|
+
</dl>
|
|
26017
|
+
|
|
26018
|
+
<dl>
|
|
26019
|
+
<dd>
|
|
26020
|
+
|
|
26021
|
+
**daily_transaction_count:** `Integer` — Maximum number of transactions allowed per day.
|
|
26022
|
+
|
|
26023
|
+
</dd>
|
|
26024
|
+
</dl>
|
|
26025
|
+
|
|
26026
|
+
<dl>
|
|
26027
|
+
<dd>
|
|
26028
|
+
|
|
26029
|
+
**daily_amount_limit:** `Integer` — Maximum total spend allowed per day.
|
|
26030
|
+
|
|
26031
|
+
</dd>
|
|
26032
|
+
</dl>
|
|
26033
|
+
|
|
26034
|
+
<dl>
|
|
26035
|
+
<dd>
|
|
26036
|
+
|
|
26037
|
+
**transaction_amount_limit:** `Integer` — Maximum spend allowed per single transaction.
|
|
26038
|
+
|
|
26039
|
+
</dd>
|
|
26040
|
+
</dl>
|
|
26041
|
+
|
|
26042
|
+
<dl>
|
|
26043
|
+
<dd>
|
|
26044
|
+
|
|
26045
|
+
**mcc:** `String` — Merchant Category Code to restrict where the card can be used. Must be a valid MCC if provided.
|
|
26046
|
+
|
|
25717
26047
|
</dd>
|
|
25718
26048
|
</dl>
|
|
25719
26049
|
|
|
@@ -25855,7 +26185,11 @@ Authorizes a transaction for payout.
|
|
|
25855
26185
|
|
|
25856
26186
|
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.
|
|
25857
26187
|
|
|
25858
|
-
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.
|
|
26188
|
+
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/api-reference/webhooks-overview/payout-transaction-approved-captured) webhook event.
|
|
26189
|
+
|
|
26190
|
+
If a velocity fraud alert is triggered, the endpoint returns a `202` response with `responseCode` `9051`, and the authorization 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.
|
|
26191
|
+
|
|
26192
|
+
For check payouts, Payabli validates the remit (mailing) address at authorization. If the address fails deliverability validation, the endpoint returns a `422` response and doesn't charge the paypoint. Correct the address and re-authorize. Other payout rails (ACH, RTP, virtual card, wire, and managed payables) aren't affected.
|
|
25859
26193
|
</dd>
|
|
25860
26194
|
</dl>
|
|
25861
26195
|
</dd>
|
|
@@ -25872,21 +26206,21 @@ When `autoCapture` is `true`, Payabli captures the transaction asynchronously af
|
|
|
25872
26206
|
```ruby
|
|
25873
26207
|
client.money_out.authorize_out(
|
|
25874
26208
|
entry_point: "8cfec329267",
|
|
25875
|
-
auto_capture: true,
|
|
25876
|
-
invoice_data: [{
|
|
25877
|
-
bill_id: 54323
|
|
25878
|
-
}],
|
|
25879
26209
|
order_description: "Window Painting",
|
|
26210
|
+
payment_method: {
|
|
26211
|
+
method_: "managed"
|
|
26212
|
+
},
|
|
25880
26213
|
payment_details: {
|
|
25881
26214
|
total_amount: 47,
|
|
25882
26215
|
unbundled: false
|
|
25883
26216
|
},
|
|
25884
|
-
payment_method: {
|
|
25885
|
-
method_: "managed"
|
|
25886
|
-
},
|
|
25887
26217
|
vendor_data: {
|
|
25888
26218
|
vendor_number: "VEN-123"
|
|
25889
|
-
}
|
|
26219
|
+
},
|
|
26220
|
+
invoice_data: [{
|
|
26221
|
+
bill_id: 54323
|
|
26222
|
+
}],
|
|
26223
|
+
auto_capture: true
|
|
25890
26224
|
)
|
|
25891
26225
|
```
|
|
25892
26226
|
</dd>
|
|
@@ -26310,7 +26644,9 @@ client.money_out.capture_all_out(body: %w[2-29 2-28 2-27])
|
|
|
26310
26644
|
<dl>
|
|
26311
26645
|
<dd>
|
|
26312
26646
|
|
|
26313
|
-
Captures a single authorized payout transaction by ID. If the transaction was authorized with `autoCapture` set to `true`,
|
|
26647
|
+
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.
|
|
26648
|
+
|
|
26649
|
+
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.
|
|
26314
26650
|
</dd>
|
|
26315
26651
|
</dl>
|
|
26316
26652
|
</dd>
|
|
@@ -26488,6 +26824,83 @@ client.money_out.v_card_get(card_token: "20230403315245421165")
|
|
|
26488
26824
|
</dl>
|
|
26489
26825
|
|
|
26490
26826
|
|
|
26827
|
+
</dd>
|
|
26828
|
+
</dl>
|
|
26829
|
+
</details>
|
|
26830
|
+
|
|
26831
|
+
<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">renew_v_card</a>(card_token, request) -> Payabli::Types::RenewVCardResponse</code></summary>
|
|
26832
|
+
<dl>
|
|
26833
|
+
<dd>
|
|
26834
|
+
|
|
26835
|
+
#### 📝 Description
|
|
26836
|
+
|
|
26837
|
+
<dl>
|
|
26838
|
+
<dd>
|
|
26839
|
+
|
|
26840
|
+
<dl>
|
|
26841
|
+
<dd>
|
|
26842
|
+
|
|
26843
|
+
Renews an expired or expiring virtual card by extending its expiration date to a future month.
|
|
26844
|
+
|
|
26845
|
+
The card must be a virtual card that hasn't been fully used. The new expiration date must be in `MM-YYYY` or `MM/YYYY` format and no more than 2 years and 363 days in the future. The card expires on the last day of the month you specify.
|
|
26846
|
+
|
|
26847
|
+
On success, `referenceId` holds the renewed card's token (the card processor may issue a new token). The response reuses the standard payout result object, so the payment-transaction fields it carries don't apply to renewal and always return `null`.
|
|
26848
|
+
</dd>
|
|
26849
|
+
</dl>
|
|
26850
|
+
</dd>
|
|
26851
|
+
</dl>
|
|
26852
|
+
|
|
26853
|
+
#### 🔌 Usage
|
|
26854
|
+
|
|
26855
|
+
<dl>
|
|
26856
|
+
<dd>
|
|
26857
|
+
|
|
26858
|
+
<dl>
|
|
26859
|
+
<dd>
|
|
26860
|
+
|
|
26861
|
+
```ruby
|
|
26862
|
+
client.money_out.renew_v_card(
|
|
26863
|
+
card_token: "20231206142225226104",
|
|
26864
|
+
expiration_date: "12-2027"
|
|
26865
|
+
)
|
|
26866
|
+
```
|
|
26867
|
+
</dd>
|
|
26868
|
+
</dl>
|
|
26869
|
+
</dd>
|
|
26870
|
+
</dl>
|
|
26871
|
+
|
|
26872
|
+
#### ⚙️ Parameters
|
|
26873
|
+
|
|
26874
|
+
<dl>
|
|
26875
|
+
<dd>
|
|
26876
|
+
|
|
26877
|
+
<dl>
|
|
26878
|
+
<dd>
|
|
26879
|
+
|
|
26880
|
+
**card_token:** `String` — ID for the virtual card to renew.
|
|
26881
|
+
|
|
26882
|
+
</dd>
|
|
26883
|
+
</dl>
|
|
26884
|
+
|
|
26885
|
+
<dl>
|
|
26886
|
+
<dd>
|
|
26887
|
+
|
|
26888
|
+
**expiration_date:** `String` — The new expiration date for the virtual card, in `MM-YYYY` or `MM/YYYY` format. The card expires on the last day of the month you specify. The date can't be more than 2 years and 363 days in the future.
|
|
26889
|
+
|
|
26890
|
+
</dd>
|
|
26891
|
+
</dl>
|
|
26892
|
+
|
|
26893
|
+
<dl>
|
|
26894
|
+
<dd>
|
|
26895
|
+
|
|
26896
|
+
**request_options:** `Payabli::MoneyOut::RequestOptions`
|
|
26897
|
+
|
|
26898
|
+
</dd>
|
|
26899
|
+
</dl>
|
|
26900
|
+
</dd>
|
|
26901
|
+
</dl>
|
|
26902
|
+
|
|
26903
|
+
|
|
26491
26904
|
</dd>
|
|
26492
26905
|
</dl>
|
|
26493
26906
|
</details>
|
|
@@ -26801,6 +27214,105 @@ client.money_out.reissue_out(
|
|
|
26801
27214
|
</dl>
|
|
26802
27215
|
|
|
26803
27216
|
|
|
27217
|
+
</dd>
|
|
27218
|
+
</dl>
|
|
27219
|
+
</details>
|
|
27220
|
+
|
|
27221
|
+
## Funding
|
|
27222
|
+
<details><summary><code>client.funding.<a href="/lib/payabli/funding/client.rb">deposit_funds</a>(request) -> Payabli::Types::DepositFundsResponse</code></summary>
|
|
27223
|
+
<dl>
|
|
27224
|
+
<dd>
|
|
27225
|
+
|
|
27226
|
+
#### 📝 Description
|
|
27227
|
+
|
|
27228
|
+
<dl>
|
|
27229
|
+
<dd>
|
|
27230
|
+
|
|
27231
|
+
<dl>
|
|
27232
|
+
<dd>
|
|
27233
|
+
|
|
27234
|
+
Deposits funds into a paypoint's available payout balance. Deposited funds enter a pending state and aren't available for instant payouts until confirmed through FBO reconciliation.
|
|
27235
|
+
</dd>
|
|
27236
|
+
</dl>
|
|
27237
|
+
</dd>
|
|
27238
|
+
</dl>
|
|
27239
|
+
|
|
27240
|
+
#### 🔌 Usage
|
|
27241
|
+
|
|
27242
|
+
<dl>
|
|
27243
|
+
<dd>
|
|
27244
|
+
|
|
27245
|
+
<dl>
|
|
27246
|
+
<dd>
|
|
27247
|
+
|
|
27248
|
+
```ruby
|
|
27249
|
+
client.funding.deposit_funds(
|
|
27250
|
+
amount: 10,
|
|
27251
|
+
entrypoint: "48acde49",
|
|
27252
|
+
account_id: "333"
|
|
27253
|
+
)
|
|
27254
|
+
```
|
|
27255
|
+
</dd>
|
|
27256
|
+
</dl>
|
|
27257
|
+
</dd>
|
|
27258
|
+
</dl>
|
|
27259
|
+
|
|
27260
|
+
#### ⚙️ Parameters
|
|
27261
|
+
|
|
27262
|
+
<dl>
|
|
27263
|
+
<dd>
|
|
27264
|
+
|
|
27265
|
+
<dl>
|
|
27266
|
+
<dd>
|
|
27267
|
+
|
|
27268
|
+
**amount:** `Integer` — The amount to deposit, in dollars. Must be greater than zero.
|
|
27269
|
+
|
|
27270
|
+
</dd>
|
|
27271
|
+
</dl>
|
|
27272
|
+
|
|
27273
|
+
<dl>
|
|
27274
|
+
<dd>
|
|
27275
|
+
|
|
27276
|
+
**entrypoint:** `String` — The entry point identifier for the paypoint receiving the deposit.
|
|
27277
|
+
|
|
27278
|
+
</dd>
|
|
27279
|
+
</dl>
|
|
27280
|
+
|
|
27281
|
+
<dl>
|
|
27282
|
+
<dd>
|
|
27283
|
+
|
|
27284
|
+
**account_id:** `String` — The remittance account ID to withdraw funds from.
|
|
27285
|
+
|
|
27286
|
+
</dd>
|
|
27287
|
+
</dl>
|
|
27288
|
+
|
|
27289
|
+
<dl>
|
|
27290
|
+
<dd>
|
|
27291
|
+
|
|
27292
|
+
**paypoint_id:** `Integer` — The paypoint ID. Optional if the entry point uniquely identifies the paypoint.
|
|
27293
|
+
|
|
27294
|
+
</dd>
|
|
27295
|
+
</dl>
|
|
27296
|
+
|
|
27297
|
+
<dl>
|
|
27298
|
+
<dd>
|
|
27299
|
+
|
|
27300
|
+
**same_day_ach:** `Internal::Types::Boolean` — When `true` and the request is submitted before 2 PM ET, the deposit processes as same-day ACH. If the request is submitted after 2 PM ET, it processes as standard ACH regardless of this flag.
|
|
27301
|
+
|
|
27302
|
+
</dd>
|
|
27303
|
+
</dl>
|
|
27304
|
+
|
|
27305
|
+
<dl>
|
|
27306
|
+
<dd>
|
|
27307
|
+
|
|
27308
|
+
**request_options:** `Payabli::Funding::RequestOptions`
|
|
27309
|
+
|
|
27310
|
+
</dd>
|
|
27311
|
+
</dl>
|
|
27312
|
+
</dd>
|
|
27313
|
+
</dl>
|
|
27314
|
+
|
|
27315
|
+
|
|
26804
27316
|
</dd>
|
|
26805
27317
|
</dl>
|
|
26806
27318
|
</details>
|