payabli 3.0.5 → 3.0.7
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/README.md +4 -1
- data/lib/payabli/bill/client.rb +119 -0
- data/lib/payabli/boarding/client.rb +209 -0
- data/lib/payabli/case_management/client.rb +662 -0
- data/lib/payabli/case_management/types/assign_case_request.rb +15 -0
- data/lib/payabli/case_management/types/create_bank_account_change_case_request.rb +31 -0
- data/lib/payabli/case_management/types/list_cases_case_management_request.rb +17 -0
- data/lib/payabli/case_management/types/list_messages_case_management_request.rb +15 -0
- data/lib/payabli/case_management/types/post_case_message_request.rb +13 -0
- data/lib/payabli/case_management/types/transition_case_request.rb +17 -0
- data/lib/payabli/case_management/types/upload_attachment_case_management_request.rb +11 -0
- data/lib/payabli/case_management/types/validate_bank_account_change_request.rb +23 -0
- data/lib/payabli/charge_backs/client.rb +20 -0
- data/lib/payabli/check_capture/client.rb +10 -0
- data/lib/payabli/client.rb +34 -5
- data/lib/payabli/cloud/client.rb +29 -0
- data/lib/payabli/customer/client.rb +54 -0
- data/lib/payabli/export/client.rb +321 -0
- data/lib/payabli/funding/client.rb +9 -0
- data/lib/payabli/ghost_card/client.rb +31 -0
- data/lib/payabli/hosted_payment_pages/client.rb +23 -0
- data/lib/payabli/import/client.rb +15 -0
- data/lib/payabli/internal/http/raw_client.rb +26 -0
- data/lib/payabli/internal/oauth_provider.rb +73 -0
- data/lib/payabli/internal/routing_auth_provider.rb +51 -0
- data/lib/payabli/invoice/client.rb +118 -0
- data/lib/payabli/line_item/client.rb +43 -0
- data/lib/payabli/management/client.rb +13 -0
- data/lib/payabli/money_in/client.rb +238 -0
- data/lib/payabli/money_out/client.rb +111 -3
- data/lib/payabli/money_out/types/capture_all_out_request.rb +2 -0
- data/lib/payabli/money_out/types/capture_out_request.rb +2 -0
- data/lib/payabli/money_out/types/request_out_authorize.rb +2 -0
- data/lib/payabli/notification/client.rb +46 -0
- data/lib/payabli/notificationlogs/client.rb +27 -0
- data/lib/payabli/ocr/client.rb +10 -0
- data/lib/payabli/organization/client.rb +91 -0
- data/lib/payabli/payment_link/client.rb +367 -0
- data/lib/payabli/payment_method_domain/client.rb +56 -0
- data/lib/payabli/payout_subscription/client.rb +50 -0
- data/lib/payabli/paypoint/client.rb +56 -0
- data/lib/payabli/query/client.rb +414 -0
- data/lib/payabli/statistic/client.rb +39 -0
- data/lib/payabli/subscription/client.rb +46 -0
- data/lib/payabli/templates/client.rb +28 -0
- data/lib/payabli/token/client.rb +8 -0
- data/lib/payabli/token_storage/client.rb +55 -0
- data/lib/payabli/types/attachment_response.rb +24 -0
- data/lib/payabli/types/available_transitions_response.rb +10 -0
- data/lib/payabli/types/bank_account_change_parameters.rb +30 -0
- data/lib/payabli/types/bank_account_change_parameters_type.rb +11 -0
- data/lib/payabli/types/bank_account_services.rb +12 -0
- data/lib/payabli/types/bank_review_decision_reason.rb +14 -0
- data/lib/payabli/types/bank_verification_metadata.rb +14 -0
- data/lib/payabli/types/case_list_response.rb +12 -0
- data/lib/payabli/types/case_list_summary.rb +20 -0
- data/lib/payabli/types/case_management_bank_account_function.rb +17 -0
- data/lib/payabli/types/case_metadata.rb +12 -0
- data/lib/payabli/types/case_response.rb +50 -0
- data/lib/payabli/types/case_state.rb +22 -0
- data/lib/payabli/types/case_trigger.rb +22 -0
- data/lib/payabli/types/case_type.rb +11 -0
- data/lib/payabli/types/message_page.rb +12 -0
- data/lib/payabli/types/money_in_service.rb +17 -0
- data/lib/payabli/types/money_out_service.rb +17 -0
- data/lib/payabli/types/notification_content.rb +1 -1
- data/lib/payabli/types/notification_content_event_type.rb +14 -80
- data/lib/payabli/types/notification_standard_request_content_event_type.rb +97 -111
- data/lib/payabli/types/org_ref.rb +12 -0
- data/lib/payabli/types/paypoint_ref.rb +12 -0
- data/lib/payabli/types/posted_message.rb +14 -0
- data/lib/payabli/types/pre_creation_validation_result.rb +16 -0
- data/lib/payabli/types/review_decision_metadata.rb +12 -0
- data/lib/payabli/types/room_message_view.rb +18 -0
- data/lib/payabli/types/state_transition_response.rb +26 -0
- data/lib/payabli/types/user_ref.rb +12 -0
- data/lib/payabli/types/verification_code.rb +14 -0
- data/lib/payabli/user/client.rb +67 -0
- data/lib/payabli/vendor/client.rb +102 -0
- data/lib/payabli/version.rb +1 -1
- data/lib/payabli/wallet/client.rb +34 -0
- data/lib/payabli.rb +38 -0
- data/reference.md +1401 -223
- data/wiremock/wiremock-mappings.json +450 -1303
- metadata +40 -2
data/reference.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Reference
|
|
2
2
|
## Bill
|
|
3
|
-
<details><summary><code>client.bill.<a href="/lib/payabli/bill/client.rb">add_bill</a>(entry
|
|
3
|
+
<details><summary><code>client.bill.<a href="/lib/payabli/bill/client.rb">add_bill</a>(entry:, request) -> Payabli::Types::BillResponse</code></summary>
|
|
4
4
|
<dl>
|
|
5
5
|
<dd>
|
|
6
6
|
|
|
@@ -113,7 +113,7 @@ client.bill.add_bill(
|
|
|
113
113
|
</dl>
|
|
114
114
|
</details>
|
|
115
115
|
|
|
116
|
-
<details><summary><code>client.bill.<a href="/lib/payabli/bill/client.rb">get_bill</a>(id_bill) -> Payabli::Types::GetBillResponse</code></summary>
|
|
116
|
+
<details><summary><code>client.bill.<a href="/lib/payabli/bill/client.rb">get_bill</a>(id_bill:) -> Payabli::Types::GetBillResponse</code></summary>
|
|
117
117
|
<dl>
|
|
118
118
|
<dd>
|
|
119
119
|
|
|
@@ -175,7 +175,7 @@ client.bill.get_bill(id_bill: 285)
|
|
|
175
175
|
</dl>
|
|
176
176
|
</details>
|
|
177
177
|
|
|
178
|
-
<details><summary><code>client.bill.<a href="/lib/payabli/bill/client.rb">edit_bill</a>(id_bill
|
|
178
|
+
<details><summary><code>client.bill.<a href="/lib/payabli/bill/client.rb">edit_bill</a>(id_bill:, request) -> Payabli::Types::EditBillResponse</code></summary>
|
|
179
179
|
<dl>
|
|
180
180
|
<dd>
|
|
181
181
|
|
|
@@ -249,7 +249,7 @@ client.bill.edit_bill(
|
|
|
249
249
|
</dl>
|
|
250
250
|
</details>
|
|
251
251
|
|
|
252
|
-
<details><summary><code>client.bill.<a href="/lib/payabli/bill/client.rb">delete_bill</a>(id_bill) -> Payabli::Types::BillResponse</code></summary>
|
|
252
|
+
<details><summary><code>client.bill.<a href="/lib/payabli/bill/client.rb">delete_bill</a>(id_bill:) -> Payabli::Types::BillResponse</code></summary>
|
|
253
253
|
<dl>
|
|
254
254
|
<dd>
|
|
255
255
|
|
|
@@ -311,7 +311,7 @@ client.bill.delete_bill(id_bill: 285)
|
|
|
311
311
|
</dl>
|
|
312
312
|
</details>
|
|
313
313
|
|
|
314
|
-
<details><summary><code>client.bill.<a href="/lib/payabli/bill/client.rb">get_attached_from_bill</a>(id_bill
|
|
314
|
+
<details><summary><code>client.bill.<a href="/lib/payabli/bill/client.rb">get_attached_from_bill</a>(id_bill:, filename:) -> Payabli::Types::FileContent</code></summary>
|
|
315
315
|
<dl>
|
|
316
316
|
<dd>
|
|
317
317
|
|
|
@@ -397,7 +397,7 @@ in the `DocumentsRef.filelist` array returned by
|
|
|
397
397
|
</dl>
|
|
398
398
|
</details>
|
|
399
399
|
|
|
400
|
-
<details><summary><code>client.bill.<a href="/lib/payabli/bill/client.rb">delete_attached_from_bill</a>(id_bill
|
|
400
|
+
<details><summary><code>client.bill.<a href="/lib/payabli/bill/client.rb">delete_attached_from_bill</a>(id_bill:, filename:) -> Payabli::Types::BillResponse</code></summary>
|
|
401
401
|
<dl>
|
|
402
402
|
<dd>
|
|
403
403
|
|
|
@@ -482,7 +482,7 @@ in the `DocumentsRef.filelist` array returned by
|
|
|
482
482
|
</dl>
|
|
483
483
|
</details>
|
|
484
484
|
|
|
485
|
-
<details><summary><code>client.bill.<a href="/lib/payabli/bill/client.rb">send_to_approval_bill</a>(id_bill
|
|
485
|
+
<details><summary><code>client.bill.<a href="/lib/payabli/bill/client.rb">send_to_approval_bill</a>(id_bill:, request) -> Payabli::Types::BillResponse</code></summary>
|
|
486
486
|
<dl>
|
|
487
487
|
<dd>
|
|
488
488
|
|
|
@@ -572,7 +572,7 @@ client.bill.send_to_approval_bill(
|
|
|
572
572
|
</dl>
|
|
573
573
|
</details>
|
|
574
574
|
|
|
575
|
-
<details><summary><code>client.bill.<a href="/lib/payabli/bill/client.rb">modify_approval_bill</a>(id_bill
|
|
575
|
+
<details><summary><code>client.bill.<a href="/lib/payabli/bill/client.rb">modify_approval_bill</a>(id_bill:, request) -> Payabli::Types::ModifyApprovalBillResponse</code></summary>
|
|
576
576
|
<dl>
|
|
577
577
|
<dd>
|
|
578
578
|
|
|
@@ -645,7 +645,7 @@ client.bill.modify_approval_bill(
|
|
|
645
645
|
</dl>
|
|
646
646
|
</details>
|
|
647
647
|
|
|
648
|
-
<details><summary><code>client.bill.<a href="/lib/payabli/bill/client.rb">set_approved_bill</a>(id_bill
|
|
648
|
+
<details><summary><code>client.bill.<a href="/lib/payabli/bill/client.rb">set_approved_bill</a>(id_bill:, approved:) -> Payabli::Types::SetApprovedBillResponse</code></summary>
|
|
649
649
|
<dl>
|
|
650
650
|
<dd>
|
|
651
651
|
|
|
@@ -726,7 +726,7 @@ client.bill.set_approved_bill(
|
|
|
726
726
|
</dl>
|
|
727
727
|
</details>
|
|
728
728
|
|
|
729
|
-
<details><summary><code>client.bill.<a href="/lib/payabli/bill/client.rb">list_bills</a>(entry) -> Payabli::Types::BillQueryResponse</code></summary>
|
|
729
|
+
<details><summary><code>client.bill.<a href="/lib/payabli/bill/client.rb">list_bills</a>(entry:) -> Payabli::Types::BillQueryResponse</code></summary>
|
|
730
730
|
<dl>
|
|
731
731
|
<dd>
|
|
732
732
|
|
|
@@ -877,7 +877,7 @@ Example: `totalAmount(gt)=20` returns all records with a `totalAmount` that's gr
|
|
|
877
877
|
</dl>
|
|
878
878
|
</details>
|
|
879
879
|
|
|
880
|
-
<details><summary><code>client.bill.<a href="/lib/payabli/bill/client.rb">list_bills_org</a>(org_id) -> Payabli::Types::BillQueryResponse</code></summary>
|
|
880
|
+
<details><summary><code>client.bill.<a href="/lib/payabli/bill/client.rb">list_bills_org</a>(org_id:) -> Payabli::Types::BillQueryResponse</code></summary>
|
|
881
881
|
<dl>
|
|
882
882
|
<dd>
|
|
883
883
|
|
|
@@ -1029,7 +1029,7 @@ Example: totalAmount(gt)=20 return all records with totalAmount greater than 20.
|
|
|
1029
1029
|
</details>
|
|
1030
1030
|
|
|
1031
1031
|
## Customer
|
|
1032
|
-
<details><summary><code>client.customer.<a href="/lib/payabli/customer/client.rb">add_customer</a>(entry
|
|
1032
|
+
<details><summary><code>client.customer.<a href="/lib/payabli/customer/client.rb">add_customer</a>(entry:, request) -> Payabli::Types::PayabliApiResponseCustomerQuery</code></summary>
|
|
1033
1033
|
<dl>
|
|
1034
1034
|
<dd>
|
|
1035
1035
|
|
|
@@ -1137,7 +1137,7 @@ client.customer.add_customer(
|
|
|
1137
1137
|
</dl>
|
|
1138
1138
|
</details>
|
|
1139
1139
|
|
|
1140
|
-
<details><summary><code>client.customer.<a href="/lib/payabli/customer/client.rb">get_customer</a>(customer_id) -> Payabli::Types::CustomerQueryRecords</code></summary>
|
|
1140
|
+
<details><summary><code>client.customer.<a href="/lib/payabli/customer/client.rb">get_customer</a>(customer_id:) -> Payabli::Types::CustomerQueryRecords</code></summary>
|
|
1141
1141
|
<dl>
|
|
1142
1142
|
<dd>
|
|
1143
1143
|
|
|
@@ -1199,7 +1199,7 @@ client.customer.get_customer(customer_id: 4440)
|
|
|
1199
1199
|
</dl>
|
|
1200
1200
|
</details>
|
|
1201
1201
|
|
|
1202
|
-
<details><summary><code>client.customer.<a href="/lib/payabli/customer/client.rb">update_customer</a>(customer_id
|
|
1202
|
+
<details><summary><code>client.customer.<a href="/lib/payabli/customer/client.rb">update_customer</a>(customer_id:, request) -> Payabli::Types::PayabliApiResponse00Responsedatanonobject</code></summary>
|
|
1203
1203
|
<dl>
|
|
1204
1204
|
<dd>
|
|
1205
1205
|
|
|
@@ -1278,7 +1278,7 @@ client.customer.update_customer(
|
|
|
1278
1278
|
</dl>
|
|
1279
1279
|
</details>
|
|
1280
1280
|
|
|
1281
|
-
<details><summary><code>client.customer.<a href="/lib/payabli/customer/client.rb">delete_customer</a>(customer_id) -> Payabli::Types::PayabliApiResponse00Responsedatanonobject</code></summary>
|
|
1281
|
+
<details><summary><code>client.customer.<a href="/lib/payabli/customer/client.rb">delete_customer</a>(customer_id:) -> Payabli::Types::PayabliApiResponse00Responsedatanonobject</code></summary>
|
|
1282
1282
|
<dl>
|
|
1283
1283
|
<dd>
|
|
1284
1284
|
|
|
@@ -1340,7 +1340,7 @@ client.customer.delete_customer(customer_id: 4440)
|
|
|
1340
1340
|
</dl>
|
|
1341
1341
|
</details>
|
|
1342
1342
|
|
|
1343
|
-
<details><summary><code>client.customer.<a href="/lib/payabli/customer/client.rb">request_consent</a>(customer_id) -> Payabli::Types::PayabliApiResponse00Responsedatanonobject</code></summary>
|
|
1343
|
+
<details><summary><code>client.customer.<a href="/lib/payabli/customer/client.rb">request_consent</a>(customer_id:) -> Payabli::Types::PayabliApiResponse00Responsedatanonobject</code></summary>
|
|
1344
1344
|
<dl>
|
|
1345
1345
|
<dd>
|
|
1346
1346
|
|
|
@@ -1402,7 +1402,7 @@ client.customer.request_consent(customer_id: 4440)
|
|
|
1402
1402
|
</dl>
|
|
1403
1403
|
</details>
|
|
1404
1404
|
|
|
1405
|
-
<details><summary><code>client.customer.<a href="/lib/payabli/customer/client.rb">link_customer_transaction</a>(customer_id
|
|
1405
|
+
<details><summary><code>client.customer.<a href="/lib/payabli/customer/client.rb">link_customer_transaction</a>(customer_id:, trans_id:) -> Payabli::Types::PayabliApiResponse00Responsedatanonobject</code></summary>
|
|
1406
1406
|
<dl>
|
|
1407
1407
|
<dd>
|
|
1408
1408
|
|
|
@@ -1672,7 +1672,7 @@ client.money_in.authorize(
|
|
|
1672
1672
|
</dl>
|
|
1673
1673
|
</details>
|
|
1674
1674
|
|
|
1675
|
-
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">capture</a>(trans_id
|
|
1675
|
+
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">capture</a>(trans_id:, amount:) -> Payabli::Types::CaptureResponse</code></summary>
|
|
1676
1676
|
<dl>
|
|
1677
1677
|
<dd>
|
|
1678
1678
|
|
|
@@ -1750,7 +1750,7 @@ client.money_in.capture(
|
|
|
1750
1750
|
</dl>
|
|
1751
1751
|
</details>
|
|
1752
1752
|
|
|
1753
|
-
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">capture_auth</a>(trans_id
|
|
1753
|
+
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">capture_auth</a>(trans_id:, request) -> Payabli::Types::CaptureResponse</code></summary>
|
|
1754
1754
|
<dl>
|
|
1755
1755
|
<dd>
|
|
1756
1756
|
|
|
@@ -1994,7 +1994,7 @@ client.money_in.credit(
|
|
|
1994
1994
|
</dl>
|
|
1995
1995
|
</details>
|
|
1996
1996
|
|
|
1997
|
-
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">details</a>(trans_id) -> Payabli::Types::TransactionQueryRecordsCustomer</code></summary>
|
|
1997
|
+
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">details</a>(trans_id:) -> Payabli::Types::TransactionQueryRecordsCustomer</code></summary>
|
|
1998
1998
|
<dl>
|
|
1999
1999
|
<dd>
|
|
2000
2000
|
|
|
@@ -2181,7 +2181,7 @@ client.money_in.getpaid(
|
|
|
2181
2181
|
</dl>
|
|
2182
2182
|
</details>
|
|
2183
2183
|
|
|
2184
|
-
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">reverse</a>(trans_id
|
|
2184
|
+
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">reverse</a>(trans_id:, amount:) -> Payabli::Types::ReverseResponse</code></summary>
|
|
2185
2185
|
<dl>
|
|
2186
2186
|
<dd>
|
|
2187
2187
|
|
|
@@ -2264,7 +2264,7 @@ An amount equal to zero will refunds the total amount authorized minus any servi
|
|
|
2264
2264
|
</dl>
|
|
2265
2265
|
</details>
|
|
2266
2266
|
|
|
2267
|
-
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">refund</a>(trans_id
|
|
2267
|
+
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">refund</a>(trans_id:, amount:) -> Payabli::Types::RefundResponse</code></summary>
|
|
2268
2268
|
<dl>
|
|
2269
2269
|
<dd>
|
|
2270
2270
|
|
|
@@ -2347,7 +2347,7 @@ An amount equal to zero will refund the total amount authorized minus any servic
|
|
|
2347
2347
|
</dl>
|
|
2348
2348
|
</details>
|
|
2349
2349
|
|
|
2350
|
-
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">refund_with_instructions</a>(trans_id
|
|
2350
|
+
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">refund_with_instructions</a>(trans_id:, request) -> Payabli::Types::RefundWithInstructionsResponse</code></summary>
|
|
2351
2351
|
<dl>
|
|
2352
2352
|
<dd>
|
|
2353
2353
|
|
|
@@ -2494,7 +2494,7 @@ An amount equal to zero will refund the total amount authorized minus any servic
|
|
|
2494
2494
|
</dl>
|
|
2495
2495
|
</details>
|
|
2496
2496
|
|
|
2497
|
-
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">reverse_credit</a>(trans_id) -> Payabli::Types::PayabliApiResponse</code></summary>
|
|
2497
|
+
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">reverse_credit</a>(trans_id:) -> Payabli::Types::PayabliApiResponse</code></summary>
|
|
2498
2498
|
<dl>
|
|
2499
2499
|
<dd>
|
|
2500
2500
|
|
|
@@ -2556,7 +2556,7 @@ client.money_in.reverse_credit(trans_id: "45-as456777hhhhhhhhhh77777777-324")
|
|
|
2556
2556
|
</dl>
|
|
2557
2557
|
</details>
|
|
2558
2558
|
|
|
2559
|
-
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">send_receipt_2_trans</a>(trans_id) -> Payabli::Types::ReceiptResponse</code></summary>
|
|
2559
|
+
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">send_receipt_2_trans</a>(trans_id:) -> Payabli::Types::ReceiptResponse</code></summary>
|
|
2560
2560
|
<dl>
|
|
2561
2561
|
<dd>
|
|
2562
2562
|
|
|
@@ -2745,7 +2745,7 @@ client.money_in.validate(
|
|
|
2745
2745
|
</dl>
|
|
2746
2746
|
</details>
|
|
2747
2747
|
|
|
2748
|
-
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">void</a>(trans_id) -> Payabli::Types::VoidResponse</code></summary>
|
|
2748
|
+
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">void</a>(trans_id:) -> Payabli::Types::VoidResponse</code></summary>
|
|
2749
2749
|
<dl>
|
|
2750
2750
|
<dd>
|
|
2751
2751
|
|
|
@@ -3023,7 +3023,7 @@ client.money_in.authorizev_2(
|
|
|
3023
3023
|
</dl>
|
|
3024
3024
|
</details>
|
|
3025
3025
|
|
|
3026
|
-
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">capturev_2</a>(trans_id
|
|
3026
|
+
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">capturev_2</a>(trans_id:, request) -> Payabli::Types::V2TransactionResponseWrapper</code></summary>
|
|
3027
3027
|
<dl>
|
|
3028
3028
|
<dd>
|
|
3029
3029
|
|
|
@@ -3099,7 +3099,7 @@ client.money_in.capturev_2(
|
|
|
3099
3099
|
</dl>
|
|
3100
3100
|
</details>
|
|
3101
3101
|
|
|
3102
|
-
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">refundv_2</a>(trans_id
|
|
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>
|
|
3103
3103
|
<dl>
|
|
3104
3104
|
<dd>
|
|
3105
3105
|
|
|
@@ -3175,7 +3175,7 @@ client.money_in.refundv_2(trans_id: "10-3ffa27df-b171-44e0-b251-e95fbfc7a723")
|
|
|
3175
3175
|
</dl>
|
|
3176
3176
|
</details>
|
|
3177
3177
|
|
|
3178
|
-
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">refundv_2_amount</a>(trans_id
|
|
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>
|
|
3179
3179
|
<dl>
|
|
3180
3180
|
<dd>
|
|
3181
3181
|
|
|
@@ -3262,7 +3262,7 @@ client.money_in.refundv_2_amount(
|
|
|
3262
3262
|
</dl>
|
|
3263
3263
|
</details>
|
|
3264
3264
|
|
|
3265
|
-
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">voidv_2</a>(trans_id) -> Payabli::Types::V2TransactionResponseWrapper</code></summary>
|
|
3265
|
+
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">voidv_2</a>(trans_id:) -> Payabli::Types::V2TransactionResponseWrapper</code></summary>
|
|
3266
3266
|
<dl>
|
|
3267
3267
|
<dd>
|
|
3268
3268
|
|
|
@@ -3415,7 +3415,7 @@ client.token.create_server_side_token(
|
|
|
3415
3415
|
</details>
|
|
3416
3416
|
|
|
3417
3417
|
## Subscription
|
|
3418
|
-
<details><summary><code>client.subscription.<a href="/lib/payabli/subscription/client.rb">get_subscription</a>(sub_id) -> Payabli::Types::SubscriptionQueryRecords</code></summary>
|
|
3418
|
+
<details><summary><code>client.subscription.<a href="/lib/payabli/subscription/client.rb">get_subscription</a>(sub_id:) -> Payabli::Types::SubscriptionQueryRecords</code></summary>
|
|
3419
3419
|
<dl>
|
|
3420
3420
|
<dd>
|
|
3421
3421
|
|
|
@@ -3477,7 +3477,7 @@ client.subscription.get_subscription(sub_id: 231)
|
|
|
3477
3477
|
</dl>
|
|
3478
3478
|
</details>
|
|
3479
3479
|
|
|
3480
|
-
<details><summary><code>client.subscription.<a href="/lib/payabli/subscription/client.rb">update_subscription</a>(sub_id
|
|
3480
|
+
<details><summary><code>client.subscription.<a href="/lib/payabli/subscription/client.rb">update_subscription</a>(sub_id:, request) -> Payabli::Types::UpdateSubscriptionResponse</code></summary>
|
|
3481
3481
|
<dl>
|
|
3482
3482
|
<dd>
|
|
3483
3483
|
|
|
@@ -3566,7 +3566,7 @@ client.subscription.update_subscription(
|
|
|
3566
3566
|
</dl>
|
|
3567
3567
|
</details>
|
|
3568
3568
|
|
|
3569
|
-
<details><summary><code>client.subscription.<a href="/lib/payabli/subscription/client.rb">remove_subscription</a>(sub_id) -> Payabli::Types::RemoveSubscriptionResponse</code></summary>
|
|
3569
|
+
<details><summary><code>client.subscription.<a href="/lib/payabli/subscription/client.rb">remove_subscription</a>(sub_id:) -> Payabli::Types::RemoveSubscriptionResponse</code></summary>
|
|
3570
3570
|
<dl>
|
|
3571
3571
|
<dd>
|
|
3572
3572
|
|
|
@@ -3803,7 +3803,7 @@ client.subscription.new_subscription(
|
|
|
3803
3803
|
</details>
|
|
3804
3804
|
|
|
3805
3805
|
## Invoice
|
|
3806
|
-
<details><summary><code>client.invoice.<a href="/lib/payabli/invoice/client.rb">add_invoice</a>(entry
|
|
3806
|
+
<details><summary><code>client.invoice.<a href="/lib/payabli/invoice/client.rb">add_invoice</a>(entry:, request) -> Payabli::Types::InvoiceResponseWithoutData</code></summary>
|
|
3807
3807
|
<dl>
|
|
3808
3808
|
<dd>
|
|
3809
3809
|
|
|
@@ -3920,7 +3920,7 @@ client.invoice.add_invoice(
|
|
|
3920
3920
|
</dl>
|
|
3921
3921
|
</details>
|
|
3922
3922
|
|
|
3923
|
-
<details><summary><code>client.invoice.<a href="/lib/payabli/invoice/client.rb">get_attached_file_from_invoice</a>(id_invoice
|
|
3923
|
+
<details><summary><code>client.invoice.<a href="/lib/payabli/invoice/client.rb">get_attached_file_from_invoice</a>(id_invoice:, filename:) -> Payabli::Types::FileContent</code></summary>
|
|
3924
3924
|
<dl>
|
|
3925
3925
|
<dd>
|
|
3926
3926
|
|
|
@@ -4005,7 +4005,7 @@ in the `DocumentsRef.filelist` array returned by
|
|
|
4005
4005
|
</dl>
|
|
4006
4006
|
</details>
|
|
4007
4007
|
|
|
4008
|
-
<details><summary><code>client.invoice.<a href="/lib/payabli/invoice/client.rb">delete_attached_from_invoice</a>(id_invoice
|
|
4008
|
+
<details><summary><code>client.invoice.<a href="/lib/payabli/invoice/client.rb">delete_attached_from_invoice</a>(id_invoice:, filename:) -> Payabli::Types::InvoiceResponseWithoutData</code></summary>
|
|
4009
4009
|
<dl>
|
|
4010
4010
|
<dd>
|
|
4011
4011
|
|
|
@@ -4082,7 +4082,7 @@ in the `DocumentsRef.filelist` array returned by
|
|
|
4082
4082
|
</dl>
|
|
4083
4083
|
</details>
|
|
4084
4084
|
|
|
4085
|
-
<details><summary><code>client.invoice.<a href="/lib/payabli/invoice/client.rb">get_invoice</a>(id_invoice) -> Payabli::Types::GetInvoiceRecord</code></summary>
|
|
4085
|
+
<details><summary><code>client.invoice.<a href="/lib/payabli/invoice/client.rb">get_invoice</a>(id_invoice:) -> Payabli::Types::GetInvoiceRecord</code></summary>
|
|
4086
4086
|
<dl>
|
|
4087
4087
|
<dd>
|
|
4088
4088
|
|
|
@@ -4144,7 +4144,7 @@ client.invoice.get_invoice(id_invoice: 23548884)
|
|
|
4144
4144
|
</dl>
|
|
4145
4145
|
</details>
|
|
4146
4146
|
|
|
4147
|
-
<details><summary><code>client.invoice.<a href="/lib/payabli/invoice/client.rb">edit_invoice</a>(id_invoice
|
|
4147
|
+
<details><summary><code>client.invoice.<a href="/lib/payabli/invoice/client.rb">edit_invoice</a>(id_invoice:, request) -> Payabli::Types::InvoiceResponseWithoutData</code></summary>
|
|
4148
4148
|
<dl>
|
|
4149
4149
|
<dd>
|
|
4150
4150
|
|
|
@@ -4235,7 +4235,7 @@ client.invoice.edit_invoice(
|
|
|
4235
4235
|
</dl>
|
|
4236
4236
|
</details>
|
|
4237
4237
|
|
|
4238
|
-
<details><summary><code>client.invoice.<a href="/lib/payabli/invoice/client.rb">delete_invoice</a>(id_invoice) -> Payabli::Types::InvoiceResponseWithoutData</code></summary>
|
|
4238
|
+
<details><summary><code>client.invoice.<a href="/lib/payabli/invoice/client.rb">delete_invoice</a>(id_invoice:) -> Payabli::Types::InvoiceResponseWithoutData</code></summary>
|
|
4239
4239
|
<dl>
|
|
4240
4240
|
<dd>
|
|
4241
4241
|
|
|
@@ -4297,7 +4297,7 @@ client.invoice.delete_invoice(id_invoice: 23548884)
|
|
|
4297
4297
|
</dl>
|
|
4298
4298
|
</details>
|
|
4299
4299
|
|
|
4300
|
-
<details><summary><code>client.invoice.<a href="/lib/payabli/invoice/client.rb">get_invoice_number</a>(entry) -> Payabli::Types::InvoiceNumberResponse</code></summary>
|
|
4300
|
+
<details><summary><code>client.invoice.<a href="/lib/payabli/invoice/client.rb">get_invoice_number</a>(entry:) -> Payabli::Types::InvoiceNumberResponse</code></summary>
|
|
4301
4301
|
<dl>
|
|
4302
4302
|
<dd>
|
|
4303
4303
|
|
|
@@ -4359,7 +4359,7 @@ client.invoice.get_invoice_number(entry: "8cfec329267")
|
|
|
4359
4359
|
</dl>
|
|
4360
4360
|
</details>
|
|
4361
4361
|
|
|
4362
|
-
<details><summary><code>client.invoice.<a href="/lib/payabli/invoice/client.rb">list_invoices</a>(entry) -> Payabli::Types::QueryInvoiceResponse</code></summary>
|
|
4362
|
+
<details><summary><code>client.invoice.<a href="/lib/payabli/invoice/client.rb">list_invoices</a>(entry:) -> Payabli::Types::QueryInvoiceResponse</code></summary>
|
|
4363
4363
|
<dl>
|
|
4364
4364
|
<dd>
|
|
4365
4365
|
|
|
@@ -4530,7 +4530,7 @@ Example: totalAmount(gt)=20 return all records with totalAmount greater than 20.
|
|
|
4530
4530
|
</dl>
|
|
4531
4531
|
</details>
|
|
4532
4532
|
|
|
4533
|
-
<details><summary><code>client.invoice.<a href="/lib/payabli/invoice/client.rb">list_invoices_org</a>(org_id) -> Payabli::Types::QueryInvoiceResponse</code></summary>
|
|
4533
|
+
<details><summary><code>client.invoice.<a href="/lib/payabli/invoice/client.rb">list_invoices_org</a>(org_id:) -> Payabli::Types::QueryInvoiceResponse</code></summary>
|
|
4534
4534
|
<dl>
|
|
4535
4535
|
<dd>
|
|
4536
4536
|
|
|
@@ -4701,7 +4701,7 @@ Example: totalAmount(gt)=20 return all records with totalAmount greater than 20.
|
|
|
4701
4701
|
</dl>
|
|
4702
4702
|
</details>
|
|
4703
4703
|
|
|
4704
|
-
<details><summary><code>client.invoice.<a href="/lib/payabli/invoice/client.rb">send_invoice</a>(id_invoice) -> Payabli::Types::SendInvoiceResponse</code></summary>
|
|
4704
|
+
<details><summary><code>client.invoice.<a href="/lib/payabli/invoice/client.rb">send_invoice</a>(id_invoice:) -> Payabli::Types::SendInvoiceResponse</code></summary>
|
|
4705
4705
|
<dl>
|
|
4706
4706
|
<dd>
|
|
4707
4707
|
|
|
@@ -4783,7 +4783,7 @@ client.invoice.send_invoice(
|
|
|
4783
4783
|
</dl>
|
|
4784
4784
|
</details>
|
|
4785
4785
|
|
|
4786
|
-
<details><summary><code>client.invoice.<a href="/lib/payabli/invoice/client.rb">get_invoice_pdf</a>(id_invoice) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
4786
|
+
<details><summary><code>client.invoice.<a href="/lib/payabli/invoice/client.rb">get_invoice_pdf</a>(id_invoice:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
4787
4787
|
<dl>
|
|
4788
4788
|
<dd>
|
|
4789
4789
|
|
|
@@ -4846,7 +4846,7 @@ client.invoice.get_invoice_pdf(id_invoice: 23548884)
|
|
|
4846
4846
|
</details>
|
|
4847
4847
|
|
|
4848
4848
|
## PaymentLink
|
|
4849
|
-
<details><summary><code>client.payment_link.<a href="/lib/payabli/payment_link/client.rb">add_pay_link_from_invoice</a>(id_invoice
|
|
4849
|
+
<details><summary><code>client.payment_link.<a href="/lib/payabli/payment_link/client.rb">add_pay_link_from_invoice</a>(id_invoice:, request) -> Payabli::Types::PayabliApiResponsePaymentLinks</code></summary>
|
|
4850
4850
|
<dl>
|
|
4851
4851
|
<dd>
|
|
4852
4852
|
|
|
@@ -5130,7 +5130,7 @@ client.payment_link.add_pay_link_from_invoice(
|
|
|
5130
5130
|
</dl>
|
|
5131
5131
|
</details>
|
|
5132
5132
|
|
|
5133
|
-
<details><summary><code>client.payment_link.<a href="/lib/payabli/payment_link/client.rb">add_pay_link_from_bill</a>(bill_id
|
|
5133
|
+
<details><summary><code>client.payment_link.<a href="/lib/payabli/payment_link/client.rb">add_pay_link_from_bill</a>(bill_id:, request) -> Payabli::Types::PayabliApiResponsePaymentLinks</code></summary>
|
|
5134
5134
|
<dl>
|
|
5135
5135
|
<dd>
|
|
5136
5136
|
|
|
@@ -5285,7 +5285,7 @@ client.payment_link.add_pay_link_from_bill(
|
|
|
5285
5285
|
</dl>
|
|
5286
5286
|
</details>
|
|
5287
5287
|
|
|
5288
|
-
<details><summary><code>client.payment_link.<a href="/lib/payabli/payment_link/client.rb">delete_pay_link_from_id</a>(pay_link_id) -> Payabli::Types::PayabliApiResponsePaymentLinks</code></summary>
|
|
5288
|
+
<details><summary><code>client.payment_link.<a href="/lib/payabli/payment_link/client.rb">delete_pay_link_from_id</a>(pay_link_id:) -> Payabli::Types::PayabliApiResponsePaymentLinks</code></summary>
|
|
5289
5289
|
<dl>
|
|
5290
5290
|
<dd>
|
|
5291
5291
|
|
|
@@ -5347,7 +5347,7 @@ client.payment_link.delete_pay_link_from_id(pay_link_id: "2325-XXXXXXX-90b1-4598
|
|
|
5347
5347
|
</dl>
|
|
5348
5348
|
</details>
|
|
5349
5349
|
|
|
5350
|
-
<details><summary><code>client.payment_link.<a href="/lib/payabli/payment_link/client.rb">get_pay_link_from_id</a>(paylink_id) -> Payabli::Types::GetPayLinkFromIdResponse</code></summary>
|
|
5350
|
+
<details><summary><code>client.payment_link.<a href="/lib/payabli/payment_link/client.rb">get_pay_link_from_id</a>(paylink_id:) -> Payabli::Types::GetPayLinkFromIdResponse</code></summary>
|
|
5351
5351
|
<dl>
|
|
5352
5352
|
<dd>
|
|
5353
5353
|
|
|
@@ -5409,7 +5409,7 @@ client.payment_link.get_pay_link_from_id(paylink_id: "2325-XXXXXXX-90b1-4598-b6c
|
|
|
5409
5409
|
</dl>
|
|
5410
5410
|
</details>
|
|
5411
5411
|
|
|
5412
|
-
<details><summary><code>client.payment_link.<a href="/lib/payabli/payment_link/client.rb">push_pay_link_from_id</a>(pay_link_id
|
|
5412
|
+
<details><summary><code>client.payment_link.<a href="/lib/payabli/payment_link/client.rb">push_pay_link_from_id</a>(pay_link_id:, request) -> Payabli::Types::PayabliApiResponsePaymentLinks</code></summary>
|
|
5413
5413
|
<dl>
|
|
5414
5414
|
<dd>
|
|
5415
5415
|
|
|
@@ -5479,7 +5479,7 @@ client.payment_link.push_pay_link_from_id(pay_link_id: "2325-XXXXXXX-90b1-4598-b
|
|
|
5479
5479
|
</dl>
|
|
5480
5480
|
</details>
|
|
5481
5481
|
|
|
5482
|
-
<details><summary><code>client.payment_link.<a href="/lib/payabli/payment_link/client.rb">refresh_pay_link_from_id</a>(pay_link_id) -> Payabli::Types::PayabliApiResponsePaymentLinks</code></summary>
|
|
5482
|
+
<details><summary><code>client.payment_link.<a href="/lib/payabli/payment_link/client.rb">refresh_pay_link_from_id</a>(pay_link_id:) -> Payabli::Types::PayabliApiResponsePaymentLinks</code></summary>
|
|
5483
5483
|
<dl>
|
|
5484
5484
|
<dd>
|
|
5485
5485
|
|
|
@@ -5549,7 +5549,7 @@ client.payment_link.refresh_pay_link_from_id(pay_link_id: "2325-XXXXXXX-90b1-459
|
|
|
5549
5549
|
</dl>
|
|
5550
5550
|
</details>
|
|
5551
5551
|
|
|
5552
|
-
<details><summary><code>client.payment_link.<a href="/lib/payabli/payment_link/client.rb">send_pay_link_from_id</a>(pay_link_id) -> Payabli::Types::PayabliApiResponsePaymentLinks</code></summary>
|
|
5552
|
+
<details><summary><code>client.payment_link.<a href="/lib/payabli/payment_link/client.rb">send_pay_link_from_id</a>(pay_link_id:) -> Payabli::Types::PayabliApiResponsePaymentLinks</code></summary>
|
|
5553
5553
|
<dl>
|
|
5554
5554
|
<dd>
|
|
5555
5555
|
|
|
@@ -5630,7 +5630,7 @@ client.payment_link.send_pay_link_from_id(
|
|
|
5630
5630
|
</dl>
|
|
5631
5631
|
</details>
|
|
5632
5632
|
|
|
5633
|
-
<details><summary><code>client.payment_link.<a href="/lib/payabli/payment_link/client.rb">update_pay_link_from_id</a>(pay_link_id
|
|
5633
|
+
<details><summary><code>client.payment_link.<a href="/lib/payabli/payment_link/client.rb">update_pay_link_from_id</a>(pay_link_id:, request) -> Payabli::Types::PayabliApiResponsePaymentLinks</code></summary>
|
|
5634
5634
|
<dl>
|
|
5635
5635
|
<dd>
|
|
5636
5636
|
|
|
@@ -5778,7 +5778,7 @@ client.payment_link.update_pay_link_from_id(
|
|
|
5778
5778
|
</dl>
|
|
5779
5779
|
</details>
|
|
5780
5780
|
|
|
5781
|
-
<details><summary><code>client.payment_link.<a href="/lib/payabli/payment_link/client.rb">add_pay_link_from_bill_lot_number</a>(lot_number
|
|
5781
|
+
<details><summary><code>client.payment_link.<a href="/lib/payabli/payment_link/client.rb">add_pay_link_from_bill_lot_number</a>(lot_number:, request) -> Payabli::Types::PayabliApiResponsePaymentLinks</code></summary>
|
|
5782
5782
|
<dl>
|
|
5783
5783
|
<dd>
|
|
5784
5784
|
|
|
@@ -5944,7 +5944,7 @@ client.payment_link.add_pay_link_from_bill_lot_number(
|
|
|
5944
5944
|
</dl>
|
|
5945
5945
|
</details>
|
|
5946
5946
|
|
|
5947
|
-
<details><summary><code>client.payment_link.<a href="/lib/payabli/payment_link/client.rb">patch_out_payment_link</a>(paylink_id
|
|
5947
|
+
<details><summary><code>client.payment_link.<a href="/lib/payabli/payment_link/client.rb">patch_out_payment_link</a>(paylink_id:, request) -> Payabli::Types::PayabliApiResponsePaymentLinks</code></summary>
|
|
5948
5948
|
<dl>
|
|
5949
5949
|
<dd>
|
|
5950
5950
|
|
|
@@ -6034,7 +6034,7 @@ client.payment_link.patch_out_payment_link(
|
|
|
6034
6034
|
</dl>
|
|
6035
6035
|
</details>
|
|
6036
6036
|
|
|
6037
|
-
<details><summary><code>client.payment_link.<a href="/lib/payabli/payment_link/client.rb">update_pay_link_out_from_id</a>(paylink_id
|
|
6037
|
+
<details><summary><code>client.payment_link.<a href="/lib/payabli/payment_link/client.rb">update_pay_link_out_from_id</a>(paylink_id:, request) -> Payabli::Types::PayabliApiResponsePaymentLinks</code></summary>
|
|
6038
6038
|
<dl>
|
|
6039
6039
|
<dd>
|
|
6040
6040
|
|
|
@@ -6284,7 +6284,7 @@ client.token_storage.add_method(
|
|
|
6284
6284
|
</dl>
|
|
6285
6285
|
</details>
|
|
6286
6286
|
|
|
6287
|
-
<details><summary><code>client.token_storage.<a href="/lib/payabli/token_storage/client.rb">get_method</a>(method_id) -> Payabli::Types::GetMethodResponse</code></summary>
|
|
6287
|
+
<details><summary><code>client.token_storage.<a href="/lib/payabli/token_storage/client.rb">get_method</a>(method_id:) -> Payabli::Types::GetMethodResponse</code></summary>
|
|
6288
6288
|
<dl>
|
|
6289
6289
|
<dd>
|
|
6290
6290
|
|
|
@@ -6376,7 +6376,7 @@ Accepted values:
|
|
|
6376
6376
|
</dl>
|
|
6377
6377
|
</details>
|
|
6378
6378
|
|
|
6379
|
-
<details><summary><code>client.token_storage.<a href="/lib/payabli/token_storage/client.rb">update_method</a>(method_id
|
|
6379
|
+
<details><summary><code>client.token_storage.<a href="/lib/payabli/token_storage/client.rb">update_method</a>(method_id:, request) -> Payabli::Types::PayabliApiResponsePaymethodDelete</code></summary>
|
|
6380
6380
|
<dl>
|
|
6381
6381
|
<dd>
|
|
6382
6382
|
|
|
@@ -6469,7 +6469,7 @@ client.token_storage.update_method(
|
|
|
6469
6469
|
</dl>
|
|
6470
6470
|
</details>
|
|
6471
6471
|
|
|
6472
|
-
<details><summary><code>client.token_storage.<a href="/lib/payabli/token_storage/client.rb">remove_method</a>(method_id) -> Payabli::Types::PayabliApiResponsePaymethodDelete</code></summary>
|
|
6472
|
+
<details><summary><code>client.token_storage.<a href="/lib/payabli/token_storage/client.rb">remove_method</a>(method_id:) -> Payabli::Types::PayabliApiResponsePaymethodDelete</code></summary>
|
|
6473
6473
|
<dl>
|
|
6474
6474
|
<dd>
|
|
6475
6475
|
|
|
@@ -6532,7 +6532,7 @@ client.token_storage.remove_method(method_id: "32-8877drt00045632-678")
|
|
|
6532
6532
|
</details>
|
|
6533
6533
|
|
|
6534
6534
|
## Paypoint
|
|
6535
|
-
<details><summary><code>client.paypoint.<a href="/lib/payabli/paypoint/client.rb">get_basic_entry</a>(entry) -> Payabli::Types::GetBasicEntryResponse</code></summary>
|
|
6535
|
+
<details><summary><code>client.paypoint.<a href="/lib/payabli/paypoint/client.rb">get_basic_entry</a>(entry:) -> Payabli::Types::GetBasicEntryResponse</code></summary>
|
|
6536
6536
|
<dl>
|
|
6537
6537
|
<dd>
|
|
6538
6538
|
|
|
@@ -6594,7 +6594,7 @@ client.paypoint.get_basic_entry(entry: "8cfec329267")
|
|
|
6594
6594
|
</dl>
|
|
6595
6595
|
</details>
|
|
6596
6596
|
|
|
6597
|
-
<details><summary><code>client.paypoint.<a href="/lib/payabli/paypoint/client.rb">get_basic_entry_by_id</a>(id_paypoint) -> Payabli::Types::GetBasicEntryByIdResponse</code></summary>
|
|
6597
|
+
<details><summary><code>client.paypoint.<a href="/lib/payabli/paypoint/client.rb">get_basic_entry_by_id</a>(id_paypoint:) -> Payabli::Types::GetBasicEntryByIdResponse</code></summary>
|
|
6598
6598
|
<dl>
|
|
6599
6599
|
<dd>
|
|
6600
6600
|
|
|
@@ -6656,7 +6656,7 @@ client.paypoint.get_basic_entry_by_id(id_paypoint: "198")
|
|
|
6656
6656
|
</dl>
|
|
6657
6657
|
</details>
|
|
6658
6658
|
|
|
6659
|
-
<details><summary><code>client.paypoint.<a href="/lib/payabli/paypoint/client.rb">save_logo</a>(entry
|
|
6659
|
+
<details><summary><code>client.paypoint.<a href="/lib/payabli/paypoint/client.rb">save_logo</a>(entry:, request) -> Payabli::Types::PayabliApiResponse00Responsedatanonobject</code></summary>
|
|
6660
6660
|
<dl>
|
|
6661
6661
|
<dd>
|
|
6662
6662
|
|
|
@@ -6814,7 +6814,7 @@ client.paypoint.migrate(
|
|
|
6814
6814
|
</dl>
|
|
6815
6815
|
</details>
|
|
6816
6816
|
|
|
6817
|
-
<details><summary><code>client.paypoint.<a href="/lib/payabli/paypoint/client.rb">settings_page</a>(entry) -> Payabli::Types::SettingsQueryRecord</code></summary>
|
|
6817
|
+
<details><summary><code>client.paypoint.<a href="/lib/payabli/paypoint/client.rb">settings_page</a>(entry:) -> Payabli::Types::SettingsQueryRecord</code></summary>
|
|
6818
6818
|
<dl>
|
|
6819
6819
|
<dd>
|
|
6820
6820
|
|
|
@@ -6876,7 +6876,7 @@ client.paypoint.settings_page(entry: "8cfec329267")
|
|
|
6876
6876
|
</dl>
|
|
6877
6877
|
</details>
|
|
6878
6878
|
|
|
6879
|
-
<details><summary><code>client.paypoint.<a href="/lib/payabli/paypoint/client.rb">get_entry_config</a>(entry) -> Payabli::Types::GetEntryConfigResponse</code></summary>
|
|
6879
|
+
<details><summary><code>client.paypoint.<a href="/lib/payabli/paypoint/client.rb">get_entry_config</a>(entry:) -> Payabli::Types::GetEntryConfigResponse</code></summary>
|
|
6880
6880
|
<dl>
|
|
6881
6881
|
<dd>
|
|
6882
6882
|
|
|
@@ -6946,7 +6946,7 @@ client.paypoint.get_entry_config(entry: "8cfec329267")
|
|
|
6946
6946
|
</dl>
|
|
6947
6947
|
</details>
|
|
6948
6948
|
|
|
6949
|
-
<details><summary><code>client.paypoint.<a href="/lib/payabli/paypoint/client.rb">get_page</a>(entry
|
|
6949
|
+
<details><summary><code>client.paypoint.<a href="/lib/payabli/paypoint/client.rb">get_page</a>(entry:, subdomain:) -> Payabli::Types::PayabliPages</code></summary>
|
|
6950
6950
|
<dl>
|
|
6951
6951
|
<dd>
|
|
6952
6952
|
|
|
@@ -7019,7 +7019,7 @@ client.paypoint.get_page(
|
|
|
7019
7019
|
</dl>
|
|
7020
7020
|
</details>
|
|
7021
7021
|
|
|
7022
|
-
<details><summary><code>client.paypoint.<a href="/lib/payabli/paypoint/client.rb">remove_page</a>(entry
|
|
7022
|
+
<details><summary><code>client.paypoint.<a href="/lib/payabli/paypoint/client.rb">remove_page</a>(entry:, subdomain:) -> Payabli::Types::PayabliApiResponseGeneric2Part</code></summary>
|
|
7023
7023
|
<dl>
|
|
7024
7024
|
<dd>
|
|
7025
7025
|
|
|
@@ -7093,7 +7093,7 @@ client.paypoint.remove_page(
|
|
|
7093
7093
|
</details>
|
|
7094
7094
|
|
|
7095
7095
|
## HostedPaymentPages
|
|
7096
|
-
<details><summary><code>client.hosted_payment_pages.<a href="/lib/payabli/hosted_payment_pages/client.rb">load_page</a>(entry
|
|
7096
|
+
<details><summary><code>client.hosted_payment_pages.<a href="/lib/payabli/hosted_payment_pages/client.rb">load_page</a>(entry:, subdomain:) -> Payabli::Types::PayabliPages</code></summary>
|
|
7097
7097
|
<dl>
|
|
7098
7098
|
<dd>
|
|
7099
7099
|
|
|
@@ -7166,7 +7166,7 @@ client.hosted_payment_pages.load_page(
|
|
|
7166
7166
|
</dl>
|
|
7167
7167
|
</details>
|
|
7168
7168
|
|
|
7169
|
-
<details><summary><code>client.hosted_payment_pages.<a href="/lib/payabli/hosted_payment_pages/client.rb">new_page</a>(entry
|
|
7169
|
+
<details><summary><code>client.hosted_payment_pages.<a href="/lib/payabli/hosted_payment_pages/client.rb">new_page</a>(entry:, request) -> Payabli::Types::PayabliApiResponse00Responsedatanonobject</code></summary>
|
|
7170
7170
|
<dl>
|
|
7171
7171
|
<dd>
|
|
7172
7172
|
|
|
@@ -7248,7 +7248,7 @@ client.hosted_payment_pages.new_page(
|
|
|
7248
7248
|
</dl>
|
|
7249
7249
|
</details>
|
|
7250
7250
|
|
|
7251
|
-
<details><summary><code>client.hosted_payment_pages.<a href="/lib/payabli/hosted_payment_pages/client.rb">save_page</a>(entry
|
|
7251
|
+
<details><summary><code>client.hosted_payment_pages.<a href="/lib/payabli/hosted_payment_pages/client.rb">save_page</a>(entry:, subdomain:, request) -> Payabli::Types::PayabliApiResponse00Responsedatanonobject</code></summary>
|
|
7252
7252
|
<dl>
|
|
7253
7253
|
<dd>
|
|
7254
7254
|
|
|
@@ -7434,7 +7434,7 @@ client.payment_method_domain.add_payment_method_domain(
|
|
|
7434
7434
|
</dl>
|
|
7435
7435
|
</details>
|
|
7436
7436
|
|
|
7437
|
-
<details><summary><code>client.payment_method_domain.<a href="/lib/payabli/payment_method_domain/client.rb">cascade_payment_method_domain</a>(domain_id) -> Payabli::Types::PaymentMethodDomainGeneralResponse</code></summary>
|
|
7437
|
+
<details><summary><code>client.payment_method_domain.<a href="/lib/payabli/payment_method_domain/client.rb">cascade_payment_method_domain</a>(domain_id:) -> Payabli::Types::PaymentMethodDomainGeneralResponse</code></summary>
|
|
7438
7438
|
<dl>
|
|
7439
7439
|
<dd>
|
|
7440
7440
|
|
|
@@ -7496,7 +7496,7 @@ client.payment_method_domain.cascade_payment_method_domain(domain_id: "pmd_b8237
|
|
|
7496
7496
|
</dl>
|
|
7497
7497
|
</details>
|
|
7498
7498
|
|
|
7499
|
-
<details><summary><code>client.payment_method_domain.<a href="/lib/payabli/payment_method_domain/client.rb">get_payment_method_domain</a>(domain_id) -> Payabli::Types::PaymentMethodDomainApiResponse</code></summary>
|
|
7499
|
+
<details><summary><code>client.payment_method_domain.<a href="/lib/payabli/payment_method_domain/client.rb">get_payment_method_domain</a>(domain_id:) -> Payabli::Types::PaymentMethodDomainApiResponse</code></summary>
|
|
7500
7500
|
<dl>
|
|
7501
7501
|
<dd>
|
|
7502
7502
|
|
|
@@ -7558,7 +7558,7 @@ client.payment_method_domain.get_payment_method_domain(domain_id: "pmd_b8237fa45
|
|
|
7558
7558
|
</dl>
|
|
7559
7559
|
</details>
|
|
7560
7560
|
|
|
7561
|
-
<details><summary><code>client.payment_method_domain.<a href="/lib/payabli/payment_method_domain/client.rb">delete_payment_method_domain</a>(domain_id) -> Payabli::Types::DeletePaymentMethodDomainResponse</code></summary>
|
|
7561
|
+
<details><summary><code>client.payment_method_domain.<a href="/lib/payabli/payment_method_domain/client.rb">delete_payment_method_domain</a>(domain_id:) -> Payabli::Types::DeletePaymentMethodDomainResponse</code></summary>
|
|
7562
7562
|
<dl>
|
|
7563
7563
|
<dd>
|
|
7564
7564
|
|
|
@@ -7620,7 +7620,7 @@ client.payment_method_domain.delete_payment_method_domain(domain_id: "pmd_b8237f
|
|
|
7620
7620
|
</dl>
|
|
7621
7621
|
</details>
|
|
7622
7622
|
|
|
7623
|
-
<details><summary><code>client.payment_method_domain.<a href="/lib/payabli/payment_method_domain/client.rb">update_payment_method_domain</a>(domain_id
|
|
7623
|
+
<details><summary><code>client.payment_method_domain.<a href="/lib/payabli/payment_method_domain/client.rb">update_payment_method_domain</a>(domain_id:, request) -> Payabli::Types::PaymentMethodDomainGeneralResponse</code></summary>
|
|
7624
7624
|
<dl>
|
|
7625
7625
|
<dd>
|
|
7626
7626
|
|
|
@@ -7803,7 +7803,7 @@ The type of entity. Valid values:
|
|
|
7803
7803
|
</dl>
|
|
7804
7804
|
</details>
|
|
7805
7805
|
|
|
7806
|
-
<details><summary><code>client.payment_method_domain.<a href="/lib/payabli/payment_method_domain/client.rb">verify_payment_method_domain</a>(domain_id) -> Payabli::Types::PaymentMethodDomainGeneralResponse</code></summary>
|
|
7806
|
+
<details><summary><code>client.payment_method_domain.<a href="/lib/payabli/payment_method_domain/client.rb">verify_payment_method_domain</a>(domain_id:) -> Payabli::Types::PaymentMethodDomainGeneralResponse</code></summary>
|
|
7807
7807
|
<dl>
|
|
7808
7808
|
<dd>
|
|
7809
7809
|
|
|
@@ -7866,7 +7866,7 @@ client.payment_method_domain.verify_payment_method_domain(domain_id: "pmd_b8237f
|
|
|
7866
7866
|
</details>
|
|
7867
7867
|
|
|
7868
7868
|
## Import
|
|
7869
|
-
<details><summary><code>client.import.<a href="/lib/payabli/import/client.rb">import_bills</a>(entry
|
|
7869
|
+
<details><summary><code>client.import.<a href="/lib/payabli/import/client.rb">import_bills</a>(entry:, request) -> Payabli::Types::PayabliApiResponseImport</code></summary>
|
|
7870
7870
|
<dl>
|
|
7871
7871
|
<dd>
|
|
7872
7872
|
|
|
@@ -7928,7 +7928,7 @@ client.import.import_bills(entry: "8cfec329267")
|
|
|
7928
7928
|
</dl>
|
|
7929
7929
|
</details>
|
|
7930
7930
|
|
|
7931
|
-
<details><summary><code>client.import.<a href="/lib/payabli/import/client.rb">import_customer</a>(entry
|
|
7931
|
+
<details><summary><code>client.import.<a href="/lib/payabli/import/client.rb">import_customer</a>(entry:, request) -> Payabli::Types::PayabliApiResponseImport</code></summary>
|
|
7932
7932
|
<dl>
|
|
7933
7933
|
<dd>
|
|
7934
7934
|
|
|
@@ -7998,7 +7998,7 @@ client.import.import_customer(entry: "8cfec329267")
|
|
|
7998
7998
|
</dl>
|
|
7999
7999
|
</details>
|
|
8000
8000
|
|
|
8001
|
-
<details><summary><code>client.import.<a href="/lib/payabli/import/client.rb">import_vendor</a>(entry
|
|
8001
|
+
<details><summary><code>client.import.<a href="/lib/payabli/import/client.rb">import_vendor</a>(entry:, request) -> Payabli::Types::PayabliApiResponseImport</code></summary>
|
|
8002
8002
|
<dl>
|
|
8003
8003
|
<dd>
|
|
8004
8004
|
|
|
@@ -8061,7 +8061,7 @@ client.import.import_vendor(entry: "8cfec329267")
|
|
|
8061
8061
|
</details>
|
|
8062
8062
|
|
|
8063
8063
|
## Query
|
|
8064
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_batch_details</a>(entry) -> Payabli::Types::QueryBatchesDetailResponse</code></summary>
|
|
8064
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_batch_details</a>(entry:) -> Payabli::Types::QueryBatchesDetailResponse</code></summary>
|
|
8065
8065
|
<dl>
|
|
8066
8066
|
<dd>
|
|
8067
8067
|
|
|
@@ -8245,7 +8245,7 @@ Example: `settledAmount(gt)=20` returns all records with a `settledAmount` great
|
|
|
8245
8245
|
</dl>
|
|
8246
8246
|
</details>
|
|
8247
8247
|
|
|
8248
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_batch_details_org</a>(org_id) -> Payabli::Types::QueryBatchesDetailResponse</code></summary>
|
|
8248
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_batch_details_org</a>(org_id:) -> Payabli::Types::QueryBatchesDetailResponse</code></summary>
|
|
8249
8249
|
<dl>
|
|
8250
8250
|
<dd>
|
|
8251
8251
|
|
|
@@ -8427,7 +8427,7 @@ Example: `settledAmount(gt)=20` returns all records with a `settledAmount` great
|
|
|
8427
8427
|
</dl>
|
|
8428
8428
|
</details>
|
|
8429
8429
|
|
|
8430
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_batches</a>(entry) -> Payabli::Types::QueryBatchesResponse</code></summary>
|
|
8430
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_batches</a>(entry:) -> Payabli::Types::QueryBatchesResponse</code></summary>
|
|
8431
8431
|
<dl>
|
|
8432
8432
|
<dd>
|
|
8433
8433
|
|
|
@@ -8589,7 +8589,7 @@ Example: `batchAmount(gt)=20` returns all records with a `batchAmount` greater t
|
|
|
8589
8589
|
</dl>
|
|
8590
8590
|
</details>
|
|
8591
8591
|
|
|
8592
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_batches_org</a>(org_id) -> Payabli::Types::QueryBatchesResponse</code></summary>
|
|
8592
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_batches_org</a>(org_id:) -> Payabli::Types::QueryBatchesResponse</code></summary>
|
|
8593
8593
|
<dl>
|
|
8594
8594
|
<dd>
|
|
8595
8595
|
|
|
@@ -8751,7 +8751,7 @@ Example: `batchAmount(gt)=20` returns all records with a `batchAmount` greater t
|
|
|
8751
8751
|
</dl>
|
|
8752
8752
|
</details>
|
|
8753
8753
|
|
|
8754
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_batches_out</a>(entry) -> Payabli::Types::QueryBatchesOutResponse</code></summary>
|
|
8754
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_batches_out</a>(entry:) -> Payabli::Types::QueryBatchesOutResponse</code></summary>
|
|
8755
8755
|
<dl>
|
|
8756
8756
|
<dd>
|
|
8757
8757
|
|
|
@@ -8874,7 +8874,7 @@ Collection of field names, conditions, and values used to filter the query. See
|
|
|
8874
8874
|
</dl>
|
|
8875
8875
|
</details>
|
|
8876
8876
|
|
|
8877
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_batches_out_org</a>(org_id) -> Payabli::Types::QueryBatchesOutResponse</code></summary>
|
|
8877
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_batches_out_org</a>(org_id:) -> Payabli::Types::QueryBatchesOutResponse</code></summary>
|
|
8878
8878
|
<dl>
|
|
8879
8879
|
<dd>
|
|
8880
8880
|
|
|
@@ -9012,7 +9012,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
9012
9012
|
</dl>
|
|
9013
9013
|
</details>
|
|
9014
9014
|
|
|
9015
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_chargebacks</a>(entry) -> Payabli::Types::QueryChargebacksResponse</code></summary>
|
|
9015
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_chargebacks</a>(entry:) -> Payabli::Types::QueryChargebacksResponse</code></summary>
|
|
9016
9016
|
<dl>
|
|
9017
9017
|
<dd>
|
|
9018
9018
|
|
|
@@ -9191,7 +9191,7 @@ Example: `netAmount(gt)=20` returns all records with a `netAmount` greater than
|
|
|
9191
9191
|
</dl>
|
|
9192
9192
|
</details>
|
|
9193
9193
|
|
|
9194
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_chargebacks_org</a>(org_id) -> Payabli::Types::QueryChargebacksResponse</code></summary>
|
|
9194
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_chargebacks_org</a>(org_id:) -> Payabli::Types::QueryChargebacksResponse</code></summary>
|
|
9195
9195
|
<dl>
|
|
9196
9196
|
<dd>
|
|
9197
9197
|
|
|
@@ -9372,7 +9372,7 @@ Example: `netAmount(gt)=20` returns all records with a `netAmount` greater than
|
|
|
9372
9372
|
</dl>
|
|
9373
9373
|
</details>
|
|
9374
9374
|
|
|
9375
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_customers</a>(entry) -> Payabli::Types::QueryCustomerResponse</code></summary>
|
|
9375
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_customers</a>(entry:) -> Payabli::Types::QueryCustomerResponse</code></summary>
|
|
9376
9376
|
<dl>
|
|
9377
9377
|
<dd>
|
|
9378
9378
|
|
|
@@ -9545,7 +9545,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
9545
9545
|
</dl>
|
|
9546
9546
|
</details>
|
|
9547
9547
|
|
|
9548
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_customers_org</a>(org_id) -> Payabli::Types::QueryCustomerResponse</code></summary>
|
|
9548
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_customers_org</a>(org_id:) -> Payabli::Types::QueryCustomerResponse</code></summary>
|
|
9549
9549
|
<dl>
|
|
9550
9550
|
<dd>
|
|
9551
9551
|
|
|
@@ -9718,7 +9718,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
9718
9718
|
</dl>
|
|
9719
9719
|
</details>
|
|
9720
9720
|
|
|
9721
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_devices</a>(entry) -> Payabli::Types::QueryDeviceResponse</code></summary>
|
|
9721
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_devices</a>(entry:) -> Payabli::Types::QueryDeviceResponse</code></summary>
|
|
9722
9722
|
<dl>
|
|
9723
9723
|
<dd>
|
|
9724
9724
|
|
|
@@ -9918,7 +9918,7 @@ for more information.
|
|
|
9918
9918
|
</dl>
|
|
9919
9919
|
</details>
|
|
9920
9920
|
|
|
9921
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_devices_org</a>(org_id) -> Payabli::Types::QueryDeviceResponse</code></summary>
|
|
9921
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_devices_org</a>(org_id:) -> Payabli::Types::QueryDeviceResponse</code></summary>
|
|
9922
9922
|
<dl>
|
|
9923
9923
|
<dd>
|
|
9924
9924
|
|
|
@@ -10118,7 +10118,7 @@ for more information.
|
|
|
10118
10118
|
</dl>
|
|
10119
10119
|
</details>
|
|
10120
10120
|
|
|
10121
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_notification_reports</a>(entry) -> Payabli::Types::QueryResponseNotificationReports</code></summary>
|
|
10121
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_notification_reports</a>(entry:) -> Payabli::Types::QueryResponseNotificationReports</code></summary>
|
|
10122
10122
|
<dl>
|
|
10123
10123
|
<dd>
|
|
10124
10124
|
|
|
@@ -10256,7 +10256,7 @@ Example: reportName(ct)=tr return all records containing the string "tr"
|
|
|
10256
10256
|
</dl>
|
|
10257
10257
|
</details>
|
|
10258
10258
|
|
|
10259
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_notification_reports_org</a>(org_id) -> Payabli::Types::QueryResponseNotificationReports</code></summary>
|
|
10259
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_notification_reports_org</a>(org_id:) -> Payabli::Types::QueryResponseNotificationReports</code></summary>
|
|
10260
10260
|
<dl>
|
|
10261
10261
|
<dd>
|
|
10262
10262
|
|
|
@@ -10392,7 +10392,7 @@ Example: reportName(ct)=tr return all records containing the string "tr"
|
|
|
10392
10392
|
</dl>
|
|
10393
10393
|
</details>
|
|
10394
10394
|
|
|
10395
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_notifications</a>(entry) -> Payabli::Types::QueryResponseNotifications</code></summary>
|
|
10395
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_notifications</a>(entry:) -> Payabli::Types::QueryResponseNotifications</code></summary>
|
|
10396
10396
|
<dl>
|
|
10397
10397
|
<dd>
|
|
10398
10398
|
|
|
@@ -10532,7 +10532,7 @@ Example: totalAmount(gt)=20 return all records with totalAmount greater than 20
|
|
|
10532
10532
|
</dl>
|
|
10533
10533
|
</details>
|
|
10534
10534
|
|
|
10535
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_notifications_org</a>(org_id) -> Payabli::Types::QueryResponseNotifications</code></summary>
|
|
10535
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_notifications_org</a>(org_id:) -> Payabli::Types::QueryResponseNotifications</code></summary>
|
|
10536
10536
|
<dl>
|
|
10537
10537
|
<dd>
|
|
10538
10538
|
|
|
@@ -10672,7 +10672,7 @@ Example: totalAmount(gt)=20 return all records with totalAmount greater than 20
|
|
|
10672
10672
|
</dl>
|
|
10673
10673
|
</details>
|
|
10674
10674
|
|
|
10675
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_organizations</a>(org_id) -> Payabli::Types::ListOrganizationsResponse</code></summary>
|
|
10675
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_organizations</a>(org_id:) -> Payabli::Types::ListOrganizationsResponse</code></summary>
|
|
10676
10676
|
<dl>
|
|
10677
10677
|
<dd>
|
|
10678
10678
|
|
|
@@ -10832,7 +10832,7 @@ Example: `dbaname(ct)=hoa` returns all records with a `dbaname` containing "hoa"
|
|
|
10832
10832
|
</dl>
|
|
10833
10833
|
</details>
|
|
10834
10834
|
|
|
10835
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_payout</a>(entry) -> Payabli::Types::QueryPayoutTransaction</code></summary>
|
|
10835
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_payout</a>(entry:) -> Payabli::Types::QueryPayoutTransaction</code></summary>
|
|
10836
10836
|
<dl>
|
|
10837
10837
|
<dd>
|
|
10838
10838
|
|
|
@@ -11019,7 +11019,7 @@ List of field names accepted:
|
|
|
11019
11019
|
</dl>
|
|
11020
11020
|
</details>
|
|
11021
11021
|
|
|
11022
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_payout_org</a>(org_id) -> Payabli::Types::QueryPayoutTransaction</code></summary>
|
|
11022
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_payout_org</a>(org_id:) -> Payabli::Types::QueryPayoutTransaction</code></summary>
|
|
11023
11023
|
<dl>
|
|
11024
11024
|
<dd>
|
|
11025
11025
|
|
|
@@ -11205,7 +11205,7 @@ List of field names accepted:
|
|
|
11205
11205
|
</dl>
|
|
11206
11206
|
</details>
|
|
11207
11207
|
|
|
11208
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_paypoints</a>(org_id) -> Payabli::Types::QueryEntrypointResponse</code></summary>
|
|
11208
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_paypoints</a>(org_id:) -> Payabli::Types::QueryEntrypointResponse</code></summary>
|
|
11209
11209
|
<dl>
|
|
11210
11210
|
<dd>
|
|
11211
11211
|
|
|
@@ -11370,7 +11370,7 @@ Example: `dbaname(ct)=hoa` returns all records with a `dbaname` containing "hoa"
|
|
|
11370
11370
|
</dl>
|
|
11371
11371
|
</details>
|
|
11372
11372
|
|
|
11373
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_settlements</a>(entry) -> Payabli::Types::QueryResponseSettlements</code></summary>
|
|
11373
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_settlements</a>(entry:) -> Payabli::Types::QueryResponseSettlements</code></summary>
|
|
11374
11374
|
<dl>
|
|
11375
11375
|
<dd>
|
|
11376
11376
|
|
|
@@ -11553,7 +11553,7 @@ Example: `settledAmount(gt)=20` returns all records with a `settledAmount` great
|
|
|
11553
11553
|
</dl>
|
|
11554
11554
|
</details>
|
|
11555
11555
|
|
|
11556
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_settlements_org</a>(org_id) -> Payabli::Types::QueryResponseSettlements</code></summary>
|
|
11556
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_settlements_org</a>(org_id:) -> Payabli::Types::QueryResponseSettlements</code></summary>
|
|
11557
11557
|
<dl>
|
|
11558
11558
|
<dd>
|
|
11559
11559
|
|
|
@@ -11736,7 +11736,7 @@ Example: `settledAmount(gt)=20` returns all records with a `settledAmount` great
|
|
|
11736
11736
|
</dl>
|
|
11737
11737
|
</details>
|
|
11738
11738
|
|
|
11739
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_subscriptions</a>(entry) -> Payabli::Types::QuerySubscriptionResponse</code></summary>
|
|
11739
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_subscriptions</a>(entry:) -> Payabli::Types::QuerySubscriptionResponse</code></summary>
|
|
11740
11740
|
<dl>
|
|
11741
11741
|
<dd>
|
|
11742
11742
|
|
|
@@ -11921,7 +11921,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
11921
11921
|
</dl>
|
|
11922
11922
|
</details>
|
|
11923
11923
|
|
|
11924
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_subscriptions_org</a>(org_id) -> Payabli::Types::QuerySubscriptionResponse</code></summary>
|
|
11924
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_subscriptions_org</a>(org_id:) -> Payabli::Types::QuerySubscriptionResponse</code></summary>
|
|
11925
11925
|
<dl>
|
|
11926
11926
|
<dd>
|
|
11927
11927
|
|
|
@@ -12106,7 +12106,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
12106
12106
|
</dl>
|
|
12107
12107
|
</details>
|
|
12108
12108
|
|
|
12109
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_payout_subscriptions</a>(entry) -> Payabli::Types::QueryPayoutSubscriptionResponse</code></summary>
|
|
12109
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_payout_subscriptions</a>(entry:) -> Payabli::Types::QueryPayoutSubscriptionResponse</code></summary>
|
|
12110
12110
|
<dl>
|
|
12111
12111
|
<dd>
|
|
12112
12112
|
|
|
@@ -12277,7 +12277,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
12277
12277
|
</dl>
|
|
12278
12278
|
</details>
|
|
12279
12279
|
|
|
12280
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_payout_subscriptions_org</a>(org_id) -> Payabli::Types::QueryPayoutSubscriptionResponse</code></summary>
|
|
12280
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_payout_subscriptions_org</a>(org_id:) -> Payabli::Types::QueryPayoutSubscriptionResponse</code></summary>
|
|
12281
12281
|
<dl>
|
|
12282
12282
|
<dd>
|
|
12283
12283
|
|
|
@@ -12448,7 +12448,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
12448
12448
|
</dl>
|
|
12449
12449
|
</details>
|
|
12450
12450
|
|
|
12451
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_transactions</a>(entry) -> Payabli::Types::QueryResponseTransactions</code></summary>
|
|
12451
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_transactions</a>(entry:) -> Payabli::Types::QueryResponseTransactions</code></summary>
|
|
12452
12452
|
<dl>
|
|
12453
12453
|
<dd>
|
|
12454
12454
|
|
|
@@ -12650,7 +12650,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
12650
12650
|
</dl>
|
|
12651
12651
|
</details>
|
|
12652
12652
|
|
|
12653
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_transactions_org</a>(org_id) -> Payabli::Types::QueryResponseTransactions</code></summary>
|
|
12653
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_transactions_org</a>(org_id:) -> Payabli::Types::QueryResponseTransactions</code></summary>
|
|
12654
12654
|
<dl>
|
|
12655
12655
|
<dd>
|
|
12656
12656
|
|
|
@@ -12851,7 +12851,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
12851
12851
|
</dl>
|
|
12852
12852
|
</details>
|
|
12853
12853
|
|
|
12854
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_transfer_details</a>(entry
|
|
12854
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_transfer_details</a>(entry:, transfer_id:) -> Payabli::Types::QueryTransferDetailResponse</code></summary>
|
|
12855
12855
|
<dl>
|
|
12856
12856
|
<dd>
|
|
12857
12857
|
|
|
@@ -13002,7 +13002,7 @@ for more information.
|
|
|
13002
13002
|
</dl>
|
|
13003
13003
|
</details>
|
|
13004
13004
|
|
|
13005
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_transfers</a>(entry) -> Payabli::Types::TransferQueryResponse</code></summary>
|
|
13005
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_transfers</a>(entry:) -> Payabli::Types::TransferQueryResponse</code></summary>
|
|
13006
13006
|
<dl>
|
|
13007
13007
|
<dd>
|
|
13008
13008
|
|
|
@@ -13144,7 +13144,7 @@ List of field names accepted:
|
|
|
13144
13144
|
</dl>
|
|
13145
13145
|
</details>
|
|
13146
13146
|
|
|
13147
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_transfers_org</a>(org_id) -> Payabli::Types::TransferQueryResponse</code></summary>
|
|
13147
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_transfers_org</a>(org_id:) -> Payabli::Types::TransferQueryResponse</code></summary>
|
|
13148
13148
|
<dl>
|
|
13149
13149
|
<dd>
|
|
13150
13150
|
|
|
@@ -13283,7 +13283,7 @@ List of field names accepted:
|
|
|
13283
13283
|
</dl>
|
|
13284
13284
|
</details>
|
|
13285
13285
|
|
|
13286
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_transfers_out_org</a>(org_id) -> Payabli::Types::TransferOutQueryResponse</code></summary>
|
|
13286
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_transfers_out_org</a>(org_id:) -> Payabli::Types::TransferOutQueryResponse</code></summary>
|
|
13287
13287
|
<dl>
|
|
13288
13288
|
<dd>
|
|
13289
13289
|
|
|
@@ -13412,7 +13412,7 @@ List of field names accepted:
|
|
|
13412
13412
|
</dl>
|
|
13413
13413
|
</details>
|
|
13414
13414
|
|
|
13415
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_transfers_out_paypoint</a>(entry) -> Payabli::Types::TransferOutQueryResponse</code></summary>
|
|
13415
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_transfers_out_paypoint</a>(entry:) -> Payabli::Types::TransferOutQueryResponse</code></summary>
|
|
13416
13416
|
<dl>
|
|
13417
13417
|
<dd>
|
|
13418
13418
|
|
|
@@ -13541,7 +13541,7 @@ List of field names accepted:
|
|
|
13541
13541
|
</dl>
|
|
13542
13542
|
</details>
|
|
13543
13543
|
|
|
13544
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_transfer_details_out</a>(entry
|
|
13544
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_transfer_details_out</a>(entry:, transfer_id:) -> Payabli::Types::TransferOutDetailQueryResponse</code></summary>
|
|
13545
13545
|
<dl>
|
|
13546
13546
|
<dd>
|
|
13547
13547
|
|
|
@@ -13676,7 +13676,7 @@ List of field names accepted:
|
|
|
13676
13676
|
</dl>
|
|
13677
13677
|
</details>
|
|
13678
13678
|
|
|
13679
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_users_org</a>(org_id) -> Payabli::Types::QueryUserResponse</code></summary>
|
|
13679
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_users_org</a>(org_id:) -> Payabli::Types::QueryUserResponse</code></summary>
|
|
13680
13680
|
<dl>
|
|
13681
13681
|
<dd>
|
|
13682
13682
|
|
|
@@ -13818,7 +13818,7 @@ Example: `name(ct)=john` return all records with name containing 'john'.
|
|
|
13818
13818
|
</dl>
|
|
13819
13819
|
</details>
|
|
13820
13820
|
|
|
13821
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_users_paypoint</a>(entry) -> Payabli::Types::QueryUserResponse</code></summary>
|
|
13821
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_users_paypoint</a>(entry:) -> Payabli::Types::QueryUserResponse</code></summary>
|
|
13822
13822
|
<dl>
|
|
13823
13823
|
<dd>
|
|
13824
13824
|
|
|
@@ -13960,7 +13960,7 @@ Example: `name(ct)=john` return all records with name containing 'john'
|
|
|
13960
13960
|
</dl>
|
|
13961
13961
|
</details>
|
|
13962
13962
|
|
|
13963
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_vendors</a>(entry) -> Payabli::Types::QueryResponseVendors</code></summary>
|
|
13963
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_vendors</a>(entry:) -> Payabli::Types::QueryResponseVendors</code></summary>
|
|
13964
13964
|
<dl>
|
|
13965
13965
|
<dd>
|
|
13966
13966
|
|
|
@@ -14123,7 +14123,7 @@ Example: `netAmount(gt)=20` returns all records with a `netAmount` greater than
|
|
|
14123
14123
|
</dl>
|
|
14124
14124
|
</details>
|
|
14125
14125
|
|
|
14126
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_vendors_org</a>(org_id) -> Payabli::Types::QueryResponseVendors</code></summary>
|
|
14126
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_vendors_org</a>(org_id:) -> Payabli::Types::QueryResponseVendors</code></summary>
|
|
14127
14127
|
<dl>
|
|
14128
14128
|
<dd>
|
|
14129
14129
|
|
|
@@ -14286,7 +14286,7 @@ Example: `netAmount(gt)=20` returns all records with a `netAmount` greater than
|
|
|
14286
14286
|
</dl>
|
|
14287
14287
|
</details>
|
|
14288
14288
|
|
|
14289
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_vcards</a>(entry) -> Payabli::Types::VCardQueryResponse</code></summary>
|
|
14289
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_vcards</a>(entry:) -> Payabli::Types::VCardQueryResponse</code></summary>
|
|
14290
14290
|
<dl>
|
|
14291
14291
|
<dd>
|
|
14292
14292
|
|
|
@@ -14443,7 +14443,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
14443
14443
|
</dl>
|
|
14444
14444
|
</details>
|
|
14445
14445
|
|
|
14446
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_vcards_transactions</a>(entry) -> Payabli::Types::VCardTransactionQueryResponse</code></summary>
|
|
14446
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_vcards_transactions</a>(entry:) -> Payabli::Types::VCardTransactionQueryResponse</code></summary>
|
|
14447
14447
|
<dl>
|
|
14448
14448
|
<dd>
|
|
14449
14449
|
|
|
@@ -14596,7 +14596,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
14596
14596
|
</dl>
|
|
14597
14597
|
</details>
|
|
14598
14598
|
|
|
14599
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_vcards_transactions_org</a>(org_id) -> Payabli::Types::VCardTransactionQueryResponse</code></summary>
|
|
14599
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_vcards_transactions_org</a>(org_id:) -> Payabli::Types::VCardTransactionQueryResponse</code></summary>
|
|
14600
14600
|
<dl>
|
|
14601
14601
|
<dd>
|
|
14602
14602
|
|
|
@@ -14749,7 +14749,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
14749
14749
|
</dl>
|
|
14750
14750
|
</details>
|
|
14751
14751
|
|
|
14752
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_vcards_org</a>(org_id) -> Payabli::Types::VCardQueryResponse</code></summary>
|
|
14752
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_vcards_org</a>(org_id:) -> Payabli::Types::VCardQueryResponse</code></summary>
|
|
14753
14753
|
<dl>
|
|
14754
14754
|
<dd>
|
|
14755
14755
|
|
|
@@ -14907,7 +14907,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
14907
14907
|
</details>
|
|
14908
14908
|
|
|
14909
14909
|
## Ocr
|
|
14910
|
-
<details><summary><code>client.ocr.<a href="/lib/payabli/ocr/client.rb">ocr_document_form</a>(type_result
|
|
14910
|
+
<details><summary><code>client.ocr.<a href="/lib/payabli/ocr/client.rb">ocr_document_form</a>(type_result:, request) -> Payabli::Types::PayabliApiResponseOcr</code></summary>
|
|
14911
14911
|
<dl>
|
|
14912
14912
|
<dd>
|
|
14913
14913
|
|
|
@@ -14977,7 +14977,7 @@ client.ocr.ocr_document_form(type_result: "typeResult")
|
|
|
14977
14977
|
</dl>
|
|
14978
14978
|
</details>
|
|
14979
14979
|
|
|
14980
|
-
<details><summary><code>client.ocr.<a href="/lib/payabli/ocr/client.rb">ocr_document_json</a>(type_result
|
|
14980
|
+
<details><summary><code>client.ocr.<a href="/lib/payabli/ocr/client.rb">ocr_document_json</a>(type_result:, request) -> Payabli::Types::PayabliApiResponseOcr</code></summary>
|
|
14981
14981
|
<dl>
|
|
14982
14982
|
<dd>
|
|
14983
14983
|
|
|
@@ -15177,7 +15177,7 @@ client.notificationlogs.search_notification_logs(
|
|
|
15177
15177
|
</dl>
|
|
15178
15178
|
</details>
|
|
15179
15179
|
|
|
15180
|
-
<details><summary><code>client.notificationlogs.<a href="/lib/payabli/notificationlogs/client.rb">get_notification_log</a>(uuid) -> Payabli::Types::NotificationLogDetail</code></summary>
|
|
15180
|
+
<details><summary><code>client.notificationlogs.<a href="/lib/payabli/notificationlogs/client.rb">get_notification_log</a>(uuid:) -> Payabli::Types::NotificationLogDetail</code></summary>
|
|
15181
15181
|
<dl>
|
|
15182
15182
|
<dd>
|
|
15183
15183
|
|
|
@@ -15240,7 +15240,7 @@ client.notificationlogs.get_notification_log(uuid: "550e8400-e29b-41d4-a716-4466
|
|
|
15240
15240
|
</dl>
|
|
15241
15241
|
</details>
|
|
15242
15242
|
|
|
15243
|
-
<details><summary><code>client.notificationlogs.<a href="/lib/payabli/notificationlogs/client.rb">retry_notification_log</a>(uuid) -> Payabli::Types::NotificationLogDetail</code></summary>
|
|
15243
|
+
<details><summary><code>client.notificationlogs.<a href="/lib/payabli/notificationlogs/client.rb">retry_notification_log</a>(uuid:) -> Payabli::Types::NotificationLogDetail</code></summary>
|
|
15244
15244
|
<dl>
|
|
15245
15245
|
<dd>
|
|
15246
15246
|
|
|
@@ -15370,7 +15370,7 @@ client.notificationlogs.bulk_retry_notification_logs(request: %w[550e8400-e29b-4
|
|
|
15370
15370
|
</details>
|
|
15371
15371
|
|
|
15372
15372
|
## Cloud
|
|
15373
|
-
<details><summary><code>client.cloud.<a href="/lib/payabli/cloud/client.rb">add_device</a>(entry
|
|
15373
|
+
<details><summary><code>client.cloud.<a href="/lib/payabli/cloud/client.rb">add_device</a>(entry:, request) -> Payabli::Types::AddDeviceResponse</code></summary>
|
|
15374
15374
|
<dl>
|
|
15375
15375
|
<dd>
|
|
15376
15376
|
|
|
@@ -15466,7 +15466,7 @@ The device registration code or serial number, depending on the model.
|
|
|
15466
15466
|
</dl>
|
|
15467
15467
|
</details>
|
|
15468
15468
|
|
|
15469
|
-
<details><summary><code>client.cloud.<a href="/lib/payabli/cloud/client.rb">remove_device</a>(entry
|
|
15469
|
+
<details><summary><code>client.cloud.<a href="/lib/payabli/cloud/client.rb">remove_device</a>(entry:, device_id:) -> Payabli::Types::RemoveDeviceResponse</code></summary>
|
|
15470
15470
|
<dl>
|
|
15471
15471
|
<dd>
|
|
15472
15472
|
|
|
@@ -15539,7 +15539,7 @@ client.cloud.remove_device(
|
|
|
15539
15539
|
</dl>
|
|
15540
15540
|
</details>
|
|
15541
15541
|
|
|
15542
|
-
<details><summary><code>client.cloud.<a href="/lib/payabli/cloud/client.rb">history_device</a>(entry
|
|
15542
|
+
<details><summary><code>client.cloud.<a href="/lib/payabli/cloud/client.rb">history_device</a>(entry:, device_id:) -> Payabli::Types::CloudQueryApiResponse</code></summary>
|
|
15543
15543
|
<dl>
|
|
15544
15544
|
<dd>
|
|
15545
15545
|
|
|
@@ -15612,7 +15612,7 @@ client.cloud.history_device(
|
|
|
15612
15612
|
</dl>
|
|
15613
15613
|
</details>
|
|
15614
15614
|
|
|
15615
|
-
<details><summary><code>client.cloud.<a href="/lib/payabli/cloud/client.rb">list_device</a>(entry) -> Payabli::Types::CloudQueryApiResponse</code></summary>
|
|
15615
|
+
<details><summary><code>client.cloud.<a href="/lib/payabli/cloud/client.rb">list_device</a>(entry:) -> Payabli::Types::CloudQueryApiResponse</code></summary>
|
|
15616
15616
|
<dl>
|
|
15617
15617
|
<dd>
|
|
15618
15618
|
|
|
@@ -15685,7 +15685,7 @@ client.cloud.list_device(entry: "8cfec329267")
|
|
|
15685
15685
|
</details>
|
|
15686
15686
|
|
|
15687
15687
|
## LineItem
|
|
15688
|
-
<details><summary><code>client.line_item.<a href="/lib/payabli/line_item/client.rb">add_item</a>(entry
|
|
15688
|
+
<details><summary><code>client.line_item.<a href="/lib/payabli/line_item/client.rb">add_item</a>(entry:, request) -> Payabli::Types::PayabliApiResponse6</code></summary>
|
|
15689
15689
|
<dl>
|
|
15690
15690
|
<dd>
|
|
15691
15691
|
|
|
@@ -15773,7 +15773,7 @@ client.line_item.add_item(
|
|
|
15773
15773
|
</dl>
|
|
15774
15774
|
</details>
|
|
15775
15775
|
|
|
15776
|
-
<details><summary><code>client.line_item.<a href="/lib/payabli/line_item/client.rb">get_item</a>(line_item_id) -> Payabli::Types::LineItemQueryRecord</code></summary>
|
|
15776
|
+
<details><summary><code>client.line_item.<a href="/lib/payabli/line_item/client.rb">get_item</a>(line_item_id:) -> Payabli::Types::LineItemQueryRecord</code></summary>
|
|
15777
15777
|
<dl>
|
|
15778
15778
|
<dd>
|
|
15779
15779
|
|
|
@@ -15835,7 +15835,7 @@ client.line_item.get_item(line_item_id: 700)
|
|
|
15835
15835
|
</dl>
|
|
15836
15836
|
</details>
|
|
15837
15837
|
|
|
15838
|
-
<details><summary><code>client.line_item.<a href="/lib/payabli/line_item/client.rb">update_item</a>(line_item_id
|
|
15838
|
+
<details><summary><code>client.line_item.<a href="/lib/payabli/line_item/client.rb">update_item</a>(line_item_id:, request) -> Payabli::Types::PayabliApiResponse6</code></summary>
|
|
15839
15839
|
<dl>
|
|
15840
15840
|
<dd>
|
|
15841
15841
|
|
|
@@ -15909,7 +15909,7 @@ client.line_item.update_item(
|
|
|
15909
15909
|
</dl>
|
|
15910
15910
|
</details>
|
|
15911
15911
|
|
|
15912
|
-
<details><summary><code>client.line_item.<a href="/lib/payabli/line_item/client.rb">delete_item</a>(line_item_id) -> Payabli::Types::DeleteItemResponse</code></summary>
|
|
15912
|
+
<details><summary><code>client.line_item.<a href="/lib/payabli/line_item/client.rb">delete_item</a>(line_item_id:) -> Payabli::Types::DeleteItemResponse</code></summary>
|
|
15913
15913
|
<dl>
|
|
15914
15914
|
<dd>
|
|
15915
15915
|
|
|
@@ -15971,7 +15971,7 @@ client.line_item.delete_item(line_item_id: 700)
|
|
|
15971
15971
|
</dl>
|
|
15972
15972
|
</details>
|
|
15973
15973
|
|
|
15974
|
-
<details><summary><code>client.line_item.<a href="/lib/payabli/line_item/client.rb">list_line_items</a>(entry) -> Payabli::Types::QueryResponseItems</code></summary>
|
|
15974
|
+
<details><summary><code>client.line_item.<a href="/lib/payabli/line_item/client.rb">list_line_items</a>(entry:) -> Payabli::Types::QueryResponseItems</code></summary>
|
|
15975
15975
|
<dl>
|
|
15976
15976
|
<dd>
|
|
15977
15977
|
|
|
@@ -16309,7 +16309,7 @@ client.boarding.add_application(
|
|
|
16309
16309
|
</dl>
|
|
16310
16310
|
</details>
|
|
16311
16311
|
|
|
16312
|
-
<details><summary><code>client.boarding.<a href="/lib/payabli/boarding/client.rb">update_application</a>(app_id
|
|
16312
|
+
<details><summary><code>client.boarding.<a href="/lib/payabli/boarding/client.rb">update_application</a>(app_id:, request) -> Payabli::Types::PayabliApiResponse00Responsedatanonobject</code></summary>
|
|
16313
16313
|
<dl>
|
|
16314
16314
|
<dd>
|
|
16315
16315
|
|
|
@@ -16379,7 +16379,7 @@ client.boarding.update_application(app_id: 352)
|
|
|
16379
16379
|
</dl>
|
|
16380
16380
|
</details>
|
|
16381
16381
|
|
|
16382
|
-
<details><summary><code>client.boarding.<a href="/lib/payabli/boarding/client.rb">delete_application</a>(app_id) -> Payabli::Types::PayabliApiResponse00Responsedatanonobject</code></summary>
|
|
16382
|
+
<details><summary><code>client.boarding.<a href="/lib/payabli/boarding/client.rb">delete_application</a>(app_id:) -> Payabli::Types::PayabliApiResponse00Responsedatanonobject</code></summary>
|
|
16383
16383
|
<dl>
|
|
16384
16384
|
<dd>
|
|
16385
16385
|
|
|
@@ -16441,7 +16441,7 @@ client.boarding.delete_application(app_id: 352)
|
|
|
16441
16441
|
</dl>
|
|
16442
16442
|
</details>
|
|
16443
16443
|
|
|
16444
|
-
<details><summary><code>client.boarding.<a href="/lib/payabli/boarding/client.rb">get_application</a>(app_id) -> Payabli::Types::ApplicationDetailsRecord</code></summary>
|
|
16444
|
+
<details><summary><code>client.boarding.<a href="/lib/payabli/boarding/client.rb">get_application</a>(app_id:) -> Payabli::Types::ApplicationDetailsRecord</code></summary>
|
|
16445
16445
|
<dl>
|
|
16446
16446
|
<dd>
|
|
16447
16447
|
|
|
@@ -16503,7 +16503,7 @@ client.boarding.get_application(app_id: 352)
|
|
|
16503
16503
|
</dl>
|
|
16504
16504
|
</details>
|
|
16505
16505
|
|
|
16506
|
-
<details><summary><code>client.boarding.<a href="/lib/payabli/boarding/client.rb">get_application_by_auth</a>(x_id
|
|
16506
|
+
<details><summary><code>client.boarding.<a href="/lib/payabli/boarding/client.rb">get_application_by_auth</a>(x_id:, request) -> Payabli::Types::ApplicationQueryRecord</code></summary>
|
|
16507
16507
|
<dl>
|
|
16508
16508
|
<dd>
|
|
16509
16509
|
|
|
@@ -16585,7 +16585,7 @@ client.boarding.get_application_by_auth(
|
|
|
16585
16585
|
</dl>
|
|
16586
16586
|
</details>
|
|
16587
16587
|
|
|
16588
|
-
<details><summary><code>client.boarding.<a href="/lib/payabli/boarding/client.rb">get_by_id_link_application</a>(boarding_link_id) -> Payabli::Types::BoardingLinkQueryRecord</code></summary>
|
|
16588
|
+
<details><summary><code>client.boarding.<a href="/lib/payabli/boarding/client.rb">get_by_id_link_application</a>(boarding_link_id:) -> Payabli::Types::BoardingLinkQueryRecord</code></summary>
|
|
16589
16589
|
<dl>
|
|
16590
16590
|
<dd>
|
|
16591
16591
|
|
|
@@ -16647,7 +16647,7 @@ client.boarding.get_by_id_link_application(boarding_link_id: 91)
|
|
|
16647
16647
|
</dl>
|
|
16648
16648
|
</details>
|
|
16649
16649
|
|
|
16650
|
-
<details><summary><code>client.boarding.<a href="/lib/payabli/boarding/client.rb">get_by_template_id_link_application</a>(template_id) -> Payabli::Types::BoardingLinkQueryRecord</code></summary>
|
|
16650
|
+
<details><summary><code>client.boarding.<a href="/lib/payabli/boarding/client.rb">get_by_template_id_link_application</a>(template_id:) -> Payabli::Types::BoardingLinkQueryRecord</code></summary>
|
|
16651
16651
|
<dl>
|
|
16652
16652
|
<dd>
|
|
16653
16653
|
|
|
@@ -16709,7 +16709,7 @@ client.boarding.get_by_template_id_link_application(template_id: 80)
|
|
|
16709
16709
|
</dl>
|
|
16710
16710
|
</details>
|
|
16711
16711
|
|
|
16712
|
-
<details><summary><code>client.boarding.<a href="/lib/payabli/boarding/client.rb">get_external_application</a>(app_id
|
|
16712
|
+
<details><summary><code>client.boarding.<a href="/lib/payabli/boarding/client.rb">get_external_application</a>(app_id:, mail_2:) -> Payabli::Types::PayabliApiResponse00</code></summary>
|
|
16713
16713
|
<dl>
|
|
16714
16714
|
<dd>
|
|
16715
16715
|
|
|
@@ -16790,7 +16790,7 @@ client.boarding.get_external_application(
|
|
|
16790
16790
|
</dl>
|
|
16791
16791
|
</details>
|
|
16792
16792
|
|
|
16793
|
-
<details><summary><code>client.boarding.<a href="/lib/payabli/boarding/client.rb">get_link_application</a>(boarding_link_reference) -> Payabli::Types::BoardingLinkQueryRecord</code></summary>
|
|
16793
|
+
<details><summary><code>client.boarding.<a href="/lib/payabli/boarding/client.rb">get_link_application</a>(boarding_link_reference:) -> Payabli::Types::BoardingLinkQueryRecord</code></summary>
|
|
16794
16794
|
<dl>
|
|
16795
16795
|
<dd>
|
|
16796
16796
|
|
|
@@ -16852,7 +16852,7 @@ client.boarding.get_link_application(boarding_link_reference: "myorgaccountname-
|
|
|
16852
16852
|
</dl>
|
|
16853
16853
|
</details>
|
|
16854
16854
|
|
|
16855
|
-
<details><summary><code>client.boarding.<a href="/lib/payabli/boarding/client.rb">list_applications</a>(org_id) -> Payabli::Types::QueryBoardingAppsListResponse</code></summary>
|
|
16855
|
+
<details><summary><code>client.boarding.<a href="/lib/payabli/boarding/client.rb">list_applications</a>(org_id:) -> Payabli::Types::QueryBoardingAppsListResponse</code></summary>
|
|
16856
16856
|
<dl>
|
|
16857
16857
|
<dd>
|
|
16858
16858
|
|
|
@@ -16995,7 +16995,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
16995
16995
|
</dl>
|
|
16996
16996
|
</details>
|
|
16997
16997
|
|
|
16998
|
-
<details><summary><code>client.boarding.<a href="/lib/payabli/boarding/client.rb">list_boarding_links</a>(org_id) -> Payabli::Types::QueryBoardingLinksResponse</code></summary>
|
|
16998
|
+
<details><summary><code>client.boarding.<a href="/lib/payabli/boarding/client.rb">list_boarding_links</a>(org_id:) -> Payabli::Types::QueryBoardingLinksResponse</code></summary>
|
|
16999
16999
|
<dl>
|
|
17000
17000
|
<dd>
|
|
17001
17001
|
|
|
@@ -17226,7 +17226,7 @@ client.boarding.add_service_to_paypoint_from_app(
|
|
|
17226
17226
|
</dl>
|
|
17227
17227
|
</details>
|
|
17228
17228
|
|
|
17229
|
-
<details><summary><code>client.boarding.<a href="/lib/payabli/boarding/client.rb">get_applications_by_paypoint_id</a>(paypoint_id) -> Payabli::Types::QueryBoardingAppsListResponse</code></summary>
|
|
17229
|
+
<details><summary><code>client.boarding.<a href="/lib/payabli/boarding/client.rb">get_applications_by_paypoint_id</a>(paypoint_id:) -> Payabli::Types::QueryBoardingAppsListResponse</code></summary>
|
|
17230
17230
|
<dl>
|
|
17231
17231
|
<dd>
|
|
17232
17232
|
|
|
@@ -17289,7 +17289,7 @@ client.boarding.get_applications_by_paypoint_id(paypoint_id: 3040)
|
|
|
17289
17289
|
</details>
|
|
17290
17290
|
|
|
17291
17291
|
## Templates
|
|
17292
|
-
<details><summary><code>client.templates.<a href="/lib/payabli/templates/client.rb">delete_template</a>(template_id) -> Payabli::Types::PayabliApiResponseTemplateId</code></summary>
|
|
17292
|
+
<details><summary><code>client.templates.<a href="/lib/payabli/templates/client.rb">delete_template</a>(template_id:) -> Payabli::Types::PayabliApiResponseTemplateId</code></summary>
|
|
17293
17293
|
<dl>
|
|
17294
17294
|
<dd>
|
|
17295
17295
|
|
|
@@ -17351,7 +17351,7 @@ client.templates.delete_template(template_id: 80)
|
|
|
17351
17351
|
</dl>
|
|
17352
17352
|
</details>
|
|
17353
17353
|
|
|
17354
|
-
<details><summary><code>client.templates.<a href="/lib/payabli/templates/client.rb">getlink_template</a>(template_id
|
|
17354
|
+
<details><summary><code>client.templates.<a href="/lib/payabli/templates/client.rb">getlink_template</a>(template_id:, ignore_empty:) -> Payabli::Types::BoardingLinkApiResponse</code></summary>
|
|
17355
17355
|
<dl>
|
|
17356
17356
|
<dd>
|
|
17357
17357
|
|
|
@@ -17424,7 +17424,7 @@ client.templates.getlink_template(
|
|
|
17424
17424
|
</dl>
|
|
17425
17425
|
</details>
|
|
17426
17426
|
|
|
17427
|
-
<details><summary><code>client.templates.<a href="/lib/payabli/templates/client.rb">get_template</a>(template_id) -> Payabli::Types::TemplateQueryRecord</code></summary>
|
|
17427
|
+
<details><summary><code>client.templates.<a href="/lib/payabli/templates/client.rb">get_template</a>(template_id:) -> Payabli::Types::TemplateQueryRecord</code></summary>
|
|
17428
17428
|
<dl>
|
|
17429
17429
|
<dd>
|
|
17430
17430
|
|
|
@@ -17486,7 +17486,7 @@ client.templates.get_template(template_id: 80)
|
|
|
17486
17486
|
</dl>
|
|
17487
17487
|
</details>
|
|
17488
17488
|
|
|
17489
|
-
<details><summary><code>client.templates.<a href="/lib/payabli/templates/client.rb">list_templates</a>(org_id) -> Payabli::Types::TemplateQueryResponse</code></summary>
|
|
17489
|
+
<details><summary><code>client.templates.<a href="/lib/payabli/templates/client.rb">list_templates</a>(org_id:) -> Payabli::Types::TemplateQueryResponse</code></summary>
|
|
17490
17490
|
<dl>
|
|
17491
17491
|
<dd>
|
|
17492
17492
|
|
|
@@ -17630,7 +17630,7 @@ Example: title(ct)=hoa return all records with title containing "hoa"
|
|
|
17630
17630
|
</details>
|
|
17631
17631
|
|
|
17632
17632
|
## Export
|
|
17633
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_applications</a>(format
|
|
17633
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_applications</a>(format:, org_id:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
17634
17634
|
<dl>
|
|
17635
17635
|
<dd>
|
|
17636
17636
|
|
|
@@ -17795,7 +17795,7 @@ Example: `dbaname(ct)=hoa` returns all records with a `dbaname` containing "hoa"
|
|
|
17795
17795
|
</dl>
|
|
17796
17796
|
</details>
|
|
17797
17797
|
|
|
17798
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_batch_details</a>(format
|
|
17798
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_batch_details</a>(format:, entry:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
17799
17799
|
<dl>
|
|
17800
17800
|
<dd>
|
|
17801
17801
|
|
|
@@ -17971,7 +17971,7 @@ Example: `amount(gt)=20` return all records with amount greater than 20.00
|
|
|
17971
17971
|
</dl>
|
|
17972
17972
|
</details>
|
|
17973
17973
|
|
|
17974
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_batch_details_org</a>(format
|
|
17974
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_batch_details_org</a>(format:, org_id:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
17975
17975
|
<dl>
|
|
17976
17976
|
<dd>
|
|
17977
17977
|
|
|
@@ -18147,7 +18147,7 @@ Example: `amount(gt)=20` return all records with amount greater than 20.00
|
|
|
18147
18147
|
</dl>
|
|
18148
18148
|
</details>
|
|
18149
18149
|
|
|
18150
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_batches</a>(format
|
|
18150
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_batches</a>(format:, entry:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
18151
18151
|
<dl>
|
|
18152
18152
|
<dd>
|
|
18153
18153
|
|
|
@@ -18313,7 +18313,7 @@ Example: `batchAmount(gt)=20` returns all records with a `batchAmount` greater t
|
|
|
18313
18313
|
</dl>
|
|
18314
18314
|
</details>
|
|
18315
18315
|
|
|
18316
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_batches_org</a>(format
|
|
18316
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_batches_org</a>(format:, org_id:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
18317
18317
|
<dl>
|
|
18318
18318
|
<dd>
|
|
18319
18319
|
|
|
@@ -18477,7 +18477,7 @@ Example: `batchAmount(gt)=20` returns all records with a `batchAmount` greater t
|
|
|
18477
18477
|
</dl>
|
|
18478
18478
|
</details>
|
|
18479
18479
|
|
|
18480
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_batches_out</a>(format
|
|
18480
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_batches_out</a>(format:, entry:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
18481
18481
|
<dl>
|
|
18482
18482
|
<dd>
|
|
18483
18483
|
|
|
@@ -18623,7 +18623,7 @@ Example: `batchAmount(gt)=20` returns all records with a `batchAmount` greater t
|
|
|
18623
18623
|
</dl>
|
|
18624
18624
|
</details>
|
|
18625
18625
|
|
|
18626
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_batches_out_org</a>(format
|
|
18626
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_batches_out_org</a>(format:, org_id:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
18627
18627
|
<dl>
|
|
18628
18628
|
<dd>
|
|
18629
18629
|
|
|
@@ -18769,7 +18769,7 @@ Example: `batchAmount(gt)=20` returns all records with a `batchAmount` greater t
|
|
|
18769
18769
|
</dl>
|
|
18770
18770
|
</details>
|
|
18771
18771
|
|
|
18772
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_bills</a>(format
|
|
18772
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_bills</a>(format:, entry:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
18773
18773
|
<dl>
|
|
18774
18774
|
<dd>
|
|
18775
18775
|
|
|
@@ -18933,7 +18933,7 @@ Example: totalAmount(gt)=20 return all records with totalAmount greater than 20
|
|
|
18933
18933
|
</dl>
|
|
18934
18934
|
</details>
|
|
18935
18935
|
|
|
18936
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_bills_org</a>(format
|
|
18936
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_bills_org</a>(format:, org_id:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
18937
18937
|
<dl>
|
|
18938
18938
|
<dd>
|
|
18939
18939
|
|
|
@@ -19097,7 +19097,7 @@ Example: totalAmount(gt)=20 return all records with totalAmount greater than 20
|
|
|
19097
19097
|
</dl>
|
|
19098
19098
|
</details>
|
|
19099
19099
|
|
|
19100
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_chargebacks</a>(format
|
|
19100
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_chargebacks</a>(format:, entry:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
19101
19101
|
<dl>
|
|
19102
19102
|
<dd>
|
|
19103
19103
|
|
|
@@ -19282,7 +19282,7 @@ Example: `netAmount(gt)=20` returns all records with a `netAmount` greater than
|
|
|
19282
19282
|
</dl>
|
|
19283
19283
|
</details>
|
|
19284
19284
|
|
|
19285
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_chargebacks_org</a>(format
|
|
19285
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_chargebacks_org</a>(format:, org_id:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
19286
19286
|
<dl>
|
|
19287
19287
|
<dd>
|
|
19288
19288
|
|
|
@@ -19467,7 +19467,7 @@ Example: `netAmount(gt)=20` returns all records with a `netAmount` greater than
|
|
|
19467
19467
|
</dl>
|
|
19468
19468
|
</details>
|
|
19469
19469
|
|
|
19470
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_customers</a>(format
|
|
19470
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_customers</a>(format:, entry:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
19471
19471
|
<dl>
|
|
19472
19472
|
<dd>
|
|
19473
19473
|
|
|
@@ -19645,7 +19645,7 @@ balance(gt)=20 return all records with balance greater than 20.00
|
|
|
19645
19645
|
</dl>
|
|
19646
19646
|
</details>
|
|
19647
19647
|
|
|
19648
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_customers_org</a>(format
|
|
19648
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_customers_org</a>(format:, org_id:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
19649
19649
|
<dl>
|
|
19650
19650
|
<dd>
|
|
19651
19651
|
|
|
@@ -19823,7 +19823,7 @@ balance(gt)=20 return all records with balance greater than 20.00
|
|
|
19823
19823
|
</dl>
|
|
19824
19824
|
</details>
|
|
19825
19825
|
|
|
19826
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_invoices</a>(format
|
|
19826
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_invoices</a>(format:, entry:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
19827
19827
|
<dl>
|
|
19828
19828
|
<dd>
|
|
19829
19829
|
|
|
@@ -20011,7 +20011,7 @@ Example: `totalAmount(gt)=20` returns all records with `totalAmount` greater tha
|
|
|
20011
20011
|
</dl>
|
|
20012
20012
|
</details>
|
|
20013
20013
|
|
|
20014
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_invoices_org</a>(format
|
|
20014
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_invoices_org</a>(format:, org_id:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
20015
20015
|
<dl>
|
|
20016
20016
|
<dd>
|
|
20017
20017
|
|
|
@@ -20199,7 +20199,7 @@ Example: totalAmount(gt)=20 return all records with totalAmount greater than 20
|
|
|
20199
20199
|
</dl>
|
|
20200
20200
|
</details>
|
|
20201
20201
|
|
|
20202
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_organizations</a>(format
|
|
20202
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_organizations</a>(format:, org_id:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
20203
20203
|
<dl>
|
|
20204
20204
|
<dd>
|
|
20205
20205
|
|
|
@@ -20362,7 +20362,7 @@ Example: name(ct)=hoa return all records where name contains "hoa"
|
|
|
20362
20362
|
</dl>
|
|
20363
20363
|
</details>
|
|
20364
20364
|
|
|
20365
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_payout</a>(format
|
|
20365
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_payout</a>(format:, entry:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
20366
20366
|
<dl>
|
|
20367
20367
|
<dd>
|
|
20368
20368
|
|
|
@@ -20524,7 +20524,7 @@ Example: totalAmount(gt)=20 return all records with totalAmount greater than 20.
|
|
|
20524
20524
|
</dl>
|
|
20525
20525
|
</details>
|
|
20526
20526
|
|
|
20527
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_payout_org</a>(format
|
|
20527
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_payout_org</a>(format:, org_id:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
20528
20528
|
<dl>
|
|
20529
20529
|
<dd>
|
|
20530
20530
|
|
|
@@ -20686,7 +20686,7 @@ Example: totalAmount(gt)=20 return all records with totalAmount greater than 20.
|
|
|
20686
20686
|
</dl>
|
|
20687
20687
|
</details>
|
|
20688
20688
|
|
|
20689
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_paypoints</a>(format
|
|
20689
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_paypoints</a>(format:, org_id:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
20690
20690
|
<dl>
|
|
20691
20691
|
<dd>
|
|
20692
20692
|
|
|
@@ -20850,7 +20850,7 @@ Example: `dbaname(ct)=hoa` returns all records with `dbaname` containing "hoa"
|
|
|
20850
20850
|
</dl>
|
|
20851
20851
|
</details>
|
|
20852
20852
|
|
|
20853
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_settlements</a>(format
|
|
20853
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_settlements</a>(format:, entry:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
20854
20854
|
<dl>
|
|
20855
20855
|
<dd>
|
|
20856
20856
|
|
|
@@ -21034,7 +21034,7 @@ Example: `settledAmount(gt)=20` returns all records with a `settledAmount` great
|
|
|
21034
21034
|
</dl>
|
|
21035
21035
|
</details>
|
|
21036
21036
|
|
|
21037
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_settlements_org</a>(format
|
|
21037
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_settlements_org</a>(format:, org_id:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
21038
21038
|
<dl>
|
|
21039
21039
|
<dd>
|
|
21040
21040
|
|
|
@@ -21218,7 +21218,7 @@ Example: `settledAmount(gt)=20` returns all records with a `settledAmount` great
|
|
|
21218
21218
|
</dl>
|
|
21219
21219
|
</details>
|
|
21220
21220
|
|
|
21221
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_subscriptions</a>(format
|
|
21221
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_subscriptions</a>(format:, entry:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
21222
21222
|
<dl>
|
|
21223
21223
|
<dd>
|
|
21224
21224
|
|
|
@@ -21404,7 +21404,7 @@ Example: `netAmount(gt)=20` returns all records with a `netAmount` greater than
|
|
|
21404
21404
|
</dl>
|
|
21405
21405
|
</details>
|
|
21406
21406
|
|
|
21407
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_subscriptions_org</a>(format
|
|
21407
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_subscriptions_org</a>(format:, org_id:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
21408
21408
|
<dl>
|
|
21409
21409
|
<dd>
|
|
21410
21410
|
|
|
@@ -21590,7 +21590,7 @@ Example: `netAmount(gt)=20` returns all records with a `netAmount` greater than
|
|
|
21590
21590
|
</dl>
|
|
21591
21591
|
</details>
|
|
21592
21592
|
|
|
21593
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_transactions</a>(format
|
|
21593
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_transactions</a>(format:, entry:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
21594
21594
|
<dl>
|
|
21595
21595
|
<dd>
|
|
21596
21596
|
|
|
@@ -21780,7 +21780,7 @@ Example: `netAmount(gt)=20` returns all records with a `netAmount` greater than
|
|
|
21780
21780
|
</dl>
|
|
21781
21781
|
</details>
|
|
21782
21782
|
|
|
21783
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_transactions_org</a>(format
|
|
21783
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_transactions_org</a>(format:, org_id:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
21784
21784
|
<dl>
|
|
21785
21785
|
<dd>
|
|
21786
21786
|
|
|
@@ -21970,7 +21970,7 @@ Example: `netAmount(gt)=20` returns all records with a `netAmount` greater than
|
|
|
21970
21970
|
</dl>
|
|
21971
21971
|
</details>
|
|
21972
21972
|
|
|
21973
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_transfer_details</a>(format
|
|
21973
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_transfer_details</a>(format:, entry:, transfer_id:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
21974
21974
|
<dl>
|
|
21975
21975
|
<dd>
|
|
21976
21976
|
|
|
@@ -22142,7 +22142,7 @@ List of field names accepted:
|
|
|
22142
22142
|
</dl>
|
|
22143
22143
|
</details>
|
|
22144
22144
|
|
|
22145
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_transfers</a>(entry) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
22145
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_transfers</a>(entry:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
22146
22146
|
<dl>
|
|
22147
22147
|
<dd>
|
|
22148
22148
|
|
|
@@ -22297,7 +22297,7 @@ List of field names accepted:
|
|
|
22297
22297
|
</dl>
|
|
22298
22298
|
</details>
|
|
22299
22299
|
|
|
22300
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_vendors</a>(format
|
|
22300
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_vendors</a>(format:, entry:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
22301
22301
|
<dl>
|
|
22302
22302
|
<dd>
|
|
22303
22303
|
|
|
@@ -22465,7 +22465,7 @@ Example: `netAmount(gt)=20` returns all records with a `netAmount` greater than
|
|
|
22465
22465
|
</dl>
|
|
22466
22466
|
</details>
|
|
22467
22467
|
|
|
22468
|
-
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_vendors_org</a>(format
|
|
22468
|
+
<details><summary><code>client.export.<a href="/lib/payabli/export/client.rb">export_vendors_org</a>(format:, org_id:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
22469
22469
|
<dl>
|
|
22470
22470
|
<dd>
|
|
22471
22471
|
|
|
@@ -22886,7 +22886,7 @@ client.organization.add_organization(
|
|
|
22886
22886
|
</dl>
|
|
22887
22887
|
</details>
|
|
22888
22888
|
|
|
22889
|
-
<details><summary><code>client.organization.<a href="/lib/payabli/organization/client.rb">edit_organization</a>(org_id
|
|
22889
|
+
<details><summary><code>client.organization.<a href="/lib/payabli/organization/client.rb">edit_organization</a>(org_id:, request) -> Payabli::Types::EditOrganizationResponse</code></summary>
|
|
22890
22890
|
<dl>
|
|
22891
22891
|
<dd>
|
|
22892
22892
|
|
|
@@ -23119,7 +23119,7 @@ client.organization.edit_organization(
|
|
|
23119
23119
|
</dl>
|
|
23120
23120
|
</details>
|
|
23121
23121
|
|
|
23122
|
-
<details><summary><code>client.organization.<a href="/lib/payabli/organization/client.rb">delete_organization</a>(org_id) -> Payabli::Types::DeleteOrganizationResponse</code></summary>
|
|
23122
|
+
<details><summary><code>client.organization.<a href="/lib/payabli/organization/client.rb">delete_organization</a>(org_id:) -> Payabli::Types::DeleteOrganizationResponse</code></summary>
|
|
23123
23123
|
<dl>
|
|
23124
23124
|
<dd>
|
|
23125
23125
|
|
|
@@ -23181,7 +23181,7 @@ client.organization.delete_organization(org_id: 123)
|
|
|
23181
23181
|
</dl>
|
|
23182
23182
|
</details>
|
|
23183
23183
|
|
|
23184
|
-
<details><summary><code>client.organization.<a href="/lib/payabli/organization/client.rb">get_basic_organization</a>(entry) -> Payabli::Types::OrganizationQueryRecord</code></summary>
|
|
23184
|
+
<details><summary><code>client.organization.<a href="/lib/payabli/organization/client.rb">get_basic_organization</a>(entry:) -> Payabli::Types::OrganizationQueryRecord</code></summary>
|
|
23185
23185
|
<dl>
|
|
23186
23186
|
<dd>
|
|
23187
23187
|
|
|
@@ -23243,7 +23243,7 @@ client.organization.get_basic_organization(entry: "8cfec329267")
|
|
|
23243
23243
|
</dl>
|
|
23244
23244
|
</details>
|
|
23245
23245
|
|
|
23246
|
-
<details><summary><code>client.organization.<a href="/lib/payabli/organization/client.rb">get_basic_organization_by_id</a>(org_id) -> Payabli::Types::OrganizationQueryRecord</code></summary>
|
|
23246
|
+
<details><summary><code>client.organization.<a href="/lib/payabli/organization/client.rb">get_basic_organization_by_id</a>(org_id:) -> Payabli::Types::OrganizationQueryRecord</code></summary>
|
|
23247
23247
|
<dl>
|
|
23248
23248
|
<dd>
|
|
23249
23249
|
|
|
@@ -23305,7 +23305,7 @@ client.organization.get_basic_organization_by_id(org_id: 123)
|
|
|
23305
23305
|
</dl>
|
|
23306
23306
|
</details>
|
|
23307
23307
|
|
|
23308
|
-
<details><summary><code>client.organization.<a href="/lib/payabli/organization/client.rb">get_organization</a>(org_id) -> Payabli::Types::OrganizationQueryRecord</code></summary>
|
|
23308
|
+
<details><summary><code>client.organization.<a href="/lib/payabli/organization/client.rb">get_organization</a>(org_id:) -> Payabli::Types::OrganizationQueryRecord</code></summary>
|
|
23309
23309
|
<dl>
|
|
23310
23310
|
<dd>
|
|
23311
23311
|
|
|
@@ -23367,7 +23367,7 @@ client.organization.get_organization(org_id: 123)
|
|
|
23367
23367
|
</dl>
|
|
23368
23368
|
</details>
|
|
23369
23369
|
|
|
23370
|
-
<details><summary><code>client.organization.<a href="/lib/payabli/organization/client.rb">get_settings_organization</a>(org_id) -> Payabli::Types::SettingsQueryRecord</code></summary>
|
|
23370
|
+
<details><summary><code>client.organization.<a href="/lib/payabli/organization/client.rb">get_settings_organization</a>(org_id:) -> Payabli::Types::SettingsQueryRecord</code></summary>
|
|
23371
23371
|
<dl>
|
|
23372
23372
|
<dd>
|
|
23373
23373
|
|
|
@@ -23430,7 +23430,7 @@ client.organization.get_settings_organization(org_id: 123)
|
|
|
23430
23430
|
</details>
|
|
23431
23431
|
|
|
23432
23432
|
## Management
|
|
23433
|
-
<details><summary><code>client.management.<a href="/lib/payabli/management/client.rb">verify_account_details</a>(entry
|
|
23433
|
+
<details><summary><code>client.management.<a href="/lib/payabli/management/client.rb">verify_account_details</a>(entry:, request) -> Payabli::Types::VerifyAccountDetailsResponse</code></summary>
|
|
23434
23434
|
<dl>
|
|
23435
23435
|
<dd>
|
|
23436
23436
|
|
|
@@ -23553,7 +23553,7 @@ client.management.verify_account_details(
|
|
|
23553
23553
|
</details>
|
|
23554
23554
|
|
|
23555
23555
|
## Statistic
|
|
23556
|
-
<details><summary><code>client.statistic.<a href="/lib/payabli/statistic/client.rb">basic_stats</a>(mode
|
|
23556
|
+
<details><summary><code>client.statistic.<a href="/lib/payabli/statistic/client.rb">basic_stats</a>(mode:, freq:, level:, entry_id:) -> Internal::Types::Array[Payabli::Types::StatBasicExtendedQueryRecord]</code></summary>
|
|
23557
23557
|
<dl>
|
|
23558
23558
|
<dd>
|
|
23559
23559
|
|
|
@@ -23712,7 +23712,7 @@ Valid formats:
|
|
|
23712
23712
|
</dl>
|
|
23713
23713
|
</details>
|
|
23714
23714
|
|
|
23715
|
-
<details><summary><code>client.statistic.<a href="/lib/payabli/statistic/client.rb">customer_basic_stats</a>(mode
|
|
23715
|
+
<details><summary><code>client.statistic.<a href="/lib/payabli/statistic/client.rb">customer_basic_stats</a>(mode:, freq:, customer_id:) -> Internal::Types::Array[Payabli::Types::SubscriptionStatsQueryRecord]</code></summary>
|
|
23716
23716
|
<dl>
|
|
23717
23717
|
<dd>
|
|
23718
23718
|
|
|
@@ -23825,7 +23825,7 @@ For example, `w` groups the results by week.
|
|
|
23825
23825
|
</dl>
|
|
23826
23826
|
</details>
|
|
23827
23827
|
|
|
23828
|
-
<details><summary><code>client.statistic.<a href="/lib/payabli/statistic/client.rb">sub_stats</a>(interval
|
|
23828
|
+
<details><summary><code>client.statistic.<a href="/lib/payabli/statistic/client.rb">sub_stats</a>(interval:, level:, entry_id:) -> Internal::Types::Array[Payabli::Types::StatBasicQueryRecord]</code></summary>
|
|
23829
23829
|
<dl>
|
|
23830
23830
|
<dd>
|
|
23831
23831
|
|
|
@@ -23927,7 +23927,7 @@ The entry level for the request:
|
|
|
23927
23927
|
</dl>
|
|
23928
23928
|
</details>
|
|
23929
23929
|
|
|
23930
|
-
<details><summary><code>client.statistic.<a href="/lib/payabli/statistic/client.rb">vendor_basic_stats</a>(mode
|
|
23930
|
+
<details><summary><code>client.statistic.<a href="/lib/payabli/statistic/client.rb">vendor_basic_stats</a>(mode:, freq:, id_vendor:) -> Internal::Types::Array[Payabli::Types::StatisticsVendorQueryRecord]</code></summary>
|
|
23931
23931
|
<dl>
|
|
23932
23932
|
<dd>
|
|
23933
23933
|
|
|
@@ -24070,7 +24070,7 @@ Create a new notification or auto-generated report.
|
|
|
24070
24070
|
```ruby
|
|
24071
24071
|
client.notification.add_notification(
|
|
24072
24072
|
content: {
|
|
24073
|
-
event_type: "
|
|
24073
|
+
event_type: "createdapplication"
|
|
24074
24074
|
},
|
|
24075
24075
|
frequency: "untilcancelled",
|
|
24076
24076
|
method_: "web",
|
|
@@ -24113,7 +24113,7 @@ client.notification.add_notification(
|
|
|
24113
24113
|
</dl>
|
|
24114
24114
|
</details>
|
|
24115
24115
|
|
|
24116
|
-
<details><summary><code>client.notification.<a href="/lib/payabli/notification/client.rb">get_notification</a>(n_id) -> Payabli::Types::NotificationQueryRecord</code></summary>
|
|
24116
|
+
<details><summary><code>client.notification.<a href="/lib/payabli/notification/client.rb">get_notification</a>(n_id:) -> Payabli::Types::NotificationQueryRecord</code></summary>
|
|
24117
24117
|
<dl>
|
|
24118
24118
|
<dd>
|
|
24119
24119
|
|
|
@@ -24175,7 +24175,7 @@ client.notification.get_notification(n_id: "1717")
|
|
|
24175
24175
|
</dl>
|
|
24176
24176
|
</details>
|
|
24177
24177
|
|
|
24178
|
-
<details><summary><code>client.notification.<a href="/lib/payabli/notification/client.rb">update_notification</a>(n_id
|
|
24178
|
+
<details><summary><code>client.notification.<a href="/lib/payabli/notification/client.rb">update_notification</a>(n_id:, request) -> Payabli::Types::PayabliApiResponseNotifications</code></summary>
|
|
24179
24179
|
<dl>
|
|
24180
24180
|
<dd>
|
|
24181
24181
|
|
|
@@ -24205,7 +24205,7 @@ Update a notification or auto-generated report.
|
|
|
24205
24205
|
client.notification.update_notification(
|
|
24206
24206
|
n_id: "1717",
|
|
24207
24207
|
content: {
|
|
24208
|
-
event_type: "
|
|
24208
|
+
event_type: "approvedpayment"
|
|
24209
24209
|
},
|
|
24210
24210
|
frequency: "untilcancelled",
|
|
24211
24211
|
method_: "email",
|
|
@@ -24256,7 +24256,7 @@ client.notification.update_notification(
|
|
|
24256
24256
|
</dl>
|
|
24257
24257
|
</details>
|
|
24258
24258
|
|
|
24259
|
-
<details><summary><code>client.notification.<a href="/lib/payabli/notification/client.rb">delete_notification</a>(n_id) -> Payabli::Types::PayabliApiResponseNotifications</code></summary>
|
|
24259
|
+
<details><summary><code>client.notification.<a href="/lib/payabli/notification/client.rb">delete_notification</a>(n_id:) -> Payabli::Types::PayabliApiResponseNotifications</code></summary>
|
|
24260
24260
|
<dl>
|
|
24261
24261
|
<dd>
|
|
24262
24262
|
|
|
@@ -24318,7 +24318,7 @@ client.notification.delete_notification(n_id: "1717")
|
|
|
24318
24318
|
</dl>
|
|
24319
24319
|
</details>
|
|
24320
24320
|
|
|
24321
|
-
<details><summary><code>client.notification.<a href="/lib/payabli/notification/client.rb">get_report_file</a>(id) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
24321
|
+
<details><summary><code>client.notification.<a href="/lib/payabli/notification/client.rb">get_report_file</a>(id:) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
24322
24322
|
<dl>
|
|
24323
24323
|
<dd>
|
|
24324
24324
|
|
|
@@ -24443,7 +24443,7 @@ client.user.add_user
|
|
|
24443
24443
|
</dl>
|
|
24444
24444
|
</details>
|
|
24445
24445
|
|
|
24446
|
-
<details><summary><code>client.user.<a href="/lib/payabli/user/client.rb">get_user</a>(user_id) -> Payabli::Types::UserQueryRecord</code></summary>
|
|
24446
|
+
<details><summary><code>client.user.<a href="/lib/payabli/user/client.rb">get_user</a>(user_id:) -> Payabli::Types::UserQueryRecord</code></summary>
|
|
24447
24447
|
<dl>
|
|
24448
24448
|
<dd>
|
|
24449
24449
|
|
|
@@ -24524,7 +24524,7 @@ client.user.get_user(
|
|
|
24524
24524
|
</dl>
|
|
24525
24525
|
</details>
|
|
24526
24526
|
|
|
24527
|
-
<details><summary><code>client.user.<a href="/lib/payabli/user/client.rb">edit_user</a>(user_id
|
|
24527
|
+
<details><summary><code>client.user.<a href="/lib/payabli/user/client.rb">edit_user</a>(user_id:, request) -> Payabli::Types::PayabliApiResponse</code></summary>
|
|
24528
24528
|
<dl>
|
|
24529
24529
|
<dd>
|
|
24530
24530
|
|
|
@@ -24594,7 +24594,7 @@ client.user.edit_user(user_id: 1000000)
|
|
|
24594
24594
|
</dl>
|
|
24595
24595
|
</details>
|
|
24596
24596
|
|
|
24597
|
-
<details><summary><code>client.user.<a href="/lib/payabli/user/client.rb">delete_user</a>(user_id) -> Payabli::Types::DeleteUserResponse</code></summary>
|
|
24597
|
+
<details><summary><code>client.user.<a href="/lib/payabli/user/client.rb">delete_user</a>(user_id:) -> Payabli::Types::DeleteUserResponse</code></summary>
|
|
24598
24598
|
<dl>
|
|
24599
24599
|
<dd>
|
|
24600
24600
|
|
|
@@ -24656,7 +24656,7 @@ client.user.delete_user(user_id: 1000000)
|
|
|
24656
24656
|
</dl>
|
|
24657
24657
|
</details>
|
|
24658
24658
|
|
|
24659
|
-
<details><summary><code>client.user.<a href="/lib/payabli/user/client.rb">auth_user</a>(provider
|
|
24659
|
+
<details><summary><code>client.user.<a href="/lib/payabli/user/client.rb">auth_user</a>(provider:, request) -> Payabli::Types::PayabliApiResponseMfaBasic</code></summary>
|
|
24660
24660
|
<dl>
|
|
24661
24661
|
<dd>
|
|
24662
24662
|
|
|
@@ -25084,7 +25084,7 @@ client.user.validate_mfa_user
|
|
|
25084
25084
|
</dl>
|
|
25085
25085
|
</details>
|
|
25086
25086
|
|
|
25087
|
-
<details><summary><code>client.user.<a href="/lib/payabli/user/client.rb">edit_mfa_user</a>(user_id
|
|
25087
|
+
<details><summary><code>client.user.<a href="/lib/payabli/user/client.rb">edit_mfa_user</a>(user_id:, request) -> Payabli::Types::EditMfaUserResponse</code></summary>
|
|
25088
25088
|
<dl>
|
|
25089
25089
|
<dd>
|
|
25090
25090
|
|
|
@@ -25154,7 +25154,7 @@ client.user.edit_mfa_user(user_id: 1000000)
|
|
|
25154
25154
|
</dl>
|
|
25155
25155
|
</details>
|
|
25156
25156
|
|
|
25157
|
-
<details><summary><code>client.user.<a href="/lib/payabli/user/client.rb">resend_mfa_code</a>(usrname
|
|
25157
|
+
<details><summary><code>client.user.<a href="/lib/payabli/user/client.rb">resend_mfa_code</a>(usrname:, entry:, entry_type:) -> Payabli::Types::PayabliApiResponseMfaBasic</code></summary>
|
|
25158
25158
|
<dl>
|
|
25159
25159
|
<dd>
|
|
25160
25160
|
|
|
@@ -25237,7 +25237,7 @@ client.user.resend_mfa_code(
|
|
|
25237
25237
|
</details>
|
|
25238
25238
|
|
|
25239
25239
|
## Vendor
|
|
25240
|
-
<details><summary><code>client.vendor.<a href="/lib/payabli/vendor/client.rb">add_vendor</a>(entry
|
|
25240
|
+
<details><summary><code>client.vendor.<a href="/lib/payabli/vendor/client.rb">add_vendor</a>(entry:, request) -> Payabli::Types::PayabliApiResponseVendors</code></summary>
|
|
25241
25241
|
<dl>
|
|
25242
25242
|
<dd>
|
|
25243
25243
|
|
|
@@ -25351,7 +25351,7 @@ client.vendor.add_vendor(
|
|
|
25351
25351
|
</dl>
|
|
25352
25352
|
</details>
|
|
25353
25353
|
|
|
25354
|
-
<details><summary><code>client.vendor.<a href="/lib/payabli/vendor/client.rb">get_vendor</a>(id_vendor) -> Payabli::Types::VendorQueryRecord</code></summary>
|
|
25354
|
+
<details><summary><code>client.vendor.<a href="/lib/payabli/vendor/client.rb">get_vendor</a>(id_vendor:) -> Payabli::Types::VendorQueryRecord</code></summary>
|
|
25355
25355
|
<dl>
|
|
25356
25356
|
<dd>
|
|
25357
25357
|
|
|
@@ -25413,7 +25413,7 @@ client.vendor.get_vendor(id_vendor: 1)
|
|
|
25413
25413
|
</dl>
|
|
25414
25414
|
</details>
|
|
25415
25415
|
|
|
25416
|
-
<details><summary><code>client.vendor.<a href="/lib/payabli/vendor/client.rb">edit_vendor</a>(id_vendor
|
|
25416
|
+
<details><summary><code>client.vendor.<a href="/lib/payabli/vendor/client.rb">edit_vendor</a>(id_vendor:, request) -> Payabli::Types::PayabliApiResponseVendors</code></summary>
|
|
25417
25417
|
<dl>
|
|
25418
25418
|
<dd>
|
|
25419
25419
|
|
|
@@ -25486,7 +25486,7 @@ client.vendor.edit_vendor(
|
|
|
25486
25486
|
</dl>
|
|
25487
25487
|
</details>
|
|
25488
25488
|
|
|
25489
|
-
<details><summary><code>client.vendor.<a href="/lib/payabli/vendor/client.rb">delete_vendor</a>(id_vendor) -> Payabli::Types::PayabliApiResponseVendors</code></summary>
|
|
25489
|
+
<details><summary><code>client.vendor.<a href="/lib/payabli/vendor/client.rb">delete_vendor</a>(id_vendor:) -> Payabli::Types::PayabliApiResponseVendors</code></summary>
|
|
25490
25490
|
<dl>
|
|
25491
25491
|
<dd>
|
|
25492
25492
|
|
|
@@ -25548,7 +25548,7 @@ client.vendor.delete_vendor(id_vendor: 1)
|
|
|
25548
25548
|
</dl>
|
|
25549
25549
|
</details>
|
|
25550
25550
|
|
|
25551
|
-
<details><summary><code>client.vendor.<a href="/lib/payabli/vendor/client.rb">enrich_vendor</a>(entry
|
|
25551
|
+
<details><summary><code>client.vendor.<a href="/lib/payabli/vendor/client.rb">enrich_vendor</a>(entry:, request) -> Payabli::Types::VendorEnrichResponse</code></summary>
|
|
25552
25552
|
<dl>
|
|
25553
25553
|
<dd>
|
|
25554
25554
|
|
|
@@ -25677,7 +25677,7 @@ client.vendor.enrich_vendor(
|
|
|
25677
25677
|
</dl>
|
|
25678
25678
|
</details>
|
|
25679
25679
|
|
|
25680
|
-
<details><summary><code>client.vendor.<a href="/lib/payabli/vendor/client.rb">schedule_enrichment_call</a>(entry
|
|
25680
|
+
<details><summary><code>client.vendor.<a href="/lib/payabli/vendor/client.rb">schedule_enrichment_call</a>(entry:, request) -> Payabli::Types::VendorScheduleCallResponse</code></summary>
|
|
25681
25681
|
<dl>
|
|
25682
25682
|
<dd>
|
|
25683
25683
|
|
|
@@ -25812,7 +25812,7 @@ client.vendor.schedule_enrichment_call(
|
|
|
25812
25812
|
</dl>
|
|
25813
25813
|
</details>
|
|
25814
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>
|
|
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>
|
|
25816
25816
|
<dl>
|
|
25817
25817
|
<dd>
|
|
25818
25818
|
|
|
@@ -25875,7 +25875,7 @@ client.vendor.get_enrichment_call_status(id_vendor: 456)
|
|
|
25875
25875
|
</details>
|
|
25876
25876
|
|
|
25877
25877
|
## GhostCard
|
|
25878
|
-
<details><summary><code>client.ghost_card.<a href="/lib/payabli/ghost_card/client.rb">create_ghost_card</a>(entry
|
|
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
25879
|
<dl>
|
|
25880
25880
|
<dd>
|
|
25881
25881
|
|
|
@@ -26086,7 +26086,7 @@ client.ghost_card.create_ghost_card(
|
|
|
26086
26086
|
</dl>
|
|
26087
26087
|
</details>
|
|
26088
26088
|
|
|
26089
|
-
<details><summary><code>client.ghost_card.<a href="/lib/payabli/ghost_card/client.rb">update_card</a>(entry
|
|
26089
|
+
<details><summary><code>client.ghost_card.<a href="/lib/payabli/ghost_card/client.rb">update_card</a>(entry:, request) -> Payabli::Types::PayabliApiResponse</code></summary>
|
|
26090
26090
|
<dl>
|
|
26091
26091
|
<dd>
|
|
26092
26092
|
|
|
@@ -26185,7 +26185,7 @@ Authorizes a transaction for payout.
|
|
|
26185
26185
|
|
|
26186
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.
|
|
26187
26187
|
|
|
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/
|
|
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/webhooks/payout-transaction-approved-captured) webhook event.
|
|
26189
26189
|
|
|
26190
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
26191
|
|
|
@@ -26260,6 +26260,18 @@ client.money_out.authorize_out(
|
|
|
26260
26260
|
<dl>
|
|
26261
26261
|
<dd>
|
|
26262
26262
|
|
|
26263
|
+
**same_day_ach:** `Internal::Types::Boolean`
|
|
26264
|
+
|
|
26265
|
+
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.
|
|
26266
|
+
|
|
26267
|
+
Same-day ACH has a daily cutoff. Capture the transaction before the cutoff, or pass `autoConvertSameDayAch` with a value of `true` when you capture it.
|
|
26268
|
+
|
|
26269
|
+
</dd>
|
|
26270
|
+
</dl>
|
|
26271
|
+
|
|
26272
|
+
<dl>
|
|
26273
|
+
<dd>
|
|
26274
|
+
|
|
26263
26275
|
**idempotency_key:** `String` — _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
|
|
26264
26276
|
|
|
26265
26277
|
</dd>
|
|
@@ -26438,7 +26450,7 @@ client.money_out.cancel_all_out(request: %w[2-29 2-28 2-27])
|
|
|
26438
26450
|
</dl>
|
|
26439
26451
|
</details>
|
|
26440
26452
|
|
|
26441
|
-
<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">cancel_out_get</a>(reference_id) -> Payabli::Types::PayabliApiResponse0000</code></summary>
|
|
26453
|
+
<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">cancel_out_get</a>(reference_id:) -> Payabli::Types::PayabliApiResponse0000</code></summary>
|
|
26442
26454
|
<dl>
|
|
26443
26455
|
<dd>
|
|
26444
26456
|
|
|
@@ -26500,7 +26512,7 @@ client.money_out.cancel_out_get(reference_id: "129-219")
|
|
|
26500
26512
|
</dl>
|
|
26501
26513
|
</details>
|
|
26502
26514
|
|
|
26503
|
-
<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">cancel_out_delete</a>(reference_id) -> Payabli::Types::PayabliApiResponse0000</code></summary>
|
|
26515
|
+
<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">cancel_out_delete</a>(reference_id:) -> Payabli::Types::PayabliApiResponse0000</code></summary>
|
|
26504
26516
|
<dl>
|
|
26505
26517
|
<dd>
|
|
26506
26518
|
|
|
@@ -26604,6 +26616,18 @@ client.money_out.capture_all_out(body: %w[2-29 2-28 2-27])
|
|
|
26604
26616
|
<dl>
|
|
26605
26617
|
<dd>
|
|
26606
26618
|
|
|
26619
|
+
**auto_convert_same_day_ach:** `Internal::Types::Boolean`
|
|
26620
|
+
|
|
26621
|
+
Controls what happens to a payout authorized with `sameDayACH` set to `true` when you capture it after the same-day ACH cutoff. When `true`, Payabli converts the payout to a standard ACH payment and captures it. When `false`, the capture is declined.
|
|
26622
|
+
|
|
26623
|
+
This parameter has no effect on payouts that weren't authorized for same-day ACH.
|
|
26624
|
+
|
|
26625
|
+
</dd>
|
|
26626
|
+
</dl>
|
|
26627
|
+
|
|
26628
|
+
<dl>
|
|
26629
|
+
<dd>
|
|
26630
|
+
|
|
26607
26631
|
**idempotency_key:** `String` — _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
|
|
26608
26632
|
|
|
26609
26633
|
</dd>
|
|
@@ -26632,7 +26656,7 @@ client.money_out.capture_all_out(body: %w[2-29 2-28 2-27])
|
|
|
26632
26656
|
</dl>
|
|
26633
26657
|
</details>
|
|
26634
26658
|
|
|
26635
|
-
<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">capture_out</a>(reference_id) -> Payabli::Types::AuthCapturePayoutResponse</code></summary>
|
|
26659
|
+
<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">capture_out</a>(reference_id:) -> Payabli::Types::AuthCapturePayoutResponse</code></summary>
|
|
26636
26660
|
<dl>
|
|
26637
26661
|
<dd>
|
|
26638
26662
|
|
|
@@ -26684,6 +26708,18 @@ client.money_out.capture_out(reference_id: "129-219")
|
|
|
26684
26708
|
<dl>
|
|
26685
26709
|
<dd>
|
|
26686
26710
|
|
|
26711
|
+
**auto_convert_same_day_ach:** `Internal::Types::Boolean`
|
|
26712
|
+
|
|
26713
|
+
Controls what happens to a payout authorized with `sameDayACH` set to `true` when you capture it after the same-day ACH cutoff. When `true`, Payabli converts the payout to a standard ACH payment and captures it. When `false`, the capture is declined.
|
|
26714
|
+
|
|
26715
|
+
This parameter has no effect on payouts that weren't authorized for same-day ACH.
|
|
26716
|
+
|
|
26717
|
+
</dd>
|
|
26718
|
+
</dl>
|
|
26719
|
+
|
|
26720
|
+
<dl>
|
|
26721
|
+
<dd>
|
|
26722
|
+
|
|
26687
26723
|
**idempotency_key:** `String` — _Optional but recommended_ A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.
|
|
26688
26724
|
|
|
26689
26725
|
</dd>
|
|
@@ -26704,7 +26740,7 @@ client.money_out.capture_out(reference_id: "129-219")
|
|
|
26704
26740
|
</dl>
|
|
26705
26741
|
</details>
|
|
26706
26742
|
|
|
26707
|
-
<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">payout_details</a>(trans_id) -> Payabli::Types::BillDetailResponse</code></summary>
|
|
26743
|
+
<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">payout_details</a>(trans_id:) -> Payabli::Types::BillDetailResponse</code></summary>
|
|
26708
26744
|
<dl>
|
|
26709
26745
|
<dd>
|
|
26710
26746
|
|
|
@@ -26766,7 +26802,7 @@ client.money_out.payout_details(trans_id: "45-as456777hhhhhhhhhh77777777-324")
|
|
|
26766
26802
|
</dl>
|
|
26767
26803
|
</details>
|
|
26768
26804
|
|
|
26769
|
-
<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">v_card_get</a>(card_token) -> Payabli::Types::VCardGetResponse</code></summary>
|
|
26805
|
+
<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">v_card_get</a>(card_token:) -> Payabli::Types::VCardGetResponse</code></summary>
|
|
26770
26806
|
<dl>
|
|
26771
26807
|
<dd>
|
|
26772
26808
|
|
|
@@ -26828,7 +26864,7 @@ client.money_out.v_card_get(card_token: "20230403315245421165")
|
|
|
26828
26864
|
</dl>
|
|
26829
26865
|
</details>
|
|
26830
26866
|
|
|
26831
|
-
<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">renew_v_card</a>(card_token
|
|
26867
|
+
<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
26868
|
<dl>
|
|
26833
26869
|
<dd>
|
|
26834
26870
|
|
|
@@ -26967,7 +27003,7 @@ client.money_out.send_v_card_link(trans_id: "01K33Z6YQZ6GD5QVKZ856MJBSC")
|
|
|
26967
27003
|
</dl>
|
|
26968
27004
|
</details>
|
|
26969
27005
|
|
|
26970
|
-
<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">get_check_image</a>(asset_name) -> String</code></summary>
|
|
27006
|
+
<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">get_check_image</a>(asset_name:) -> String</code></summary>
|
|
26971
27007
|
<dl>
|
|
26972
27008
|
<dd>
|
|
26973
27009
|
|
|
@@ -27042,7 +27078,7 @@ in the response when you make a GET request to `/MoneyOut/details/{transId}`.
|
|
|
27042
27078
|
</dl>
|
|
27043
27079
|
</details>
|
|
27044
27080
|
|
|
27045
|
-
<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">update_check_payment_status</a>(trans_id
|
|
27081
|
+
<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">update_check_payment_status</a>(trans_id:, check_payment_status:) -> Payabli::Types::PayabliApiResponse00Responsedatanonobject</code></summary>
|
|
27046
27082
|
<dl>
|
|
27047
27083
|
<dd>
|
|
27048
27084
|
|
|
@@ -27799,7 +27835,7 @@ client.payout_subscription.create_payout_subscription(
|
|
|
27799
27835
|
</dl>
|
|
27800
27836
|
</details>
|
|
27801
27837
|
|
|
27802
|
-
<details><summary><code>client.payout_subscription.<a href="/lib/payabli/payout_subscription/client.rb">get_payout_subscription</a>(id) -> Payabli::Types::GetPayoutSubscriptionResponse</code></summary>
|
|
27838
|
+
<details><summary><code>client.payout_subscription.<a href="/lib/payabli/payout_subscription/client.rb">get_payout_subscription</a>(id:) -> Payabli::Types::GetPayoutSubscriptionResponse</code></summary>
|
|
27803
27839
|
<dl>
|
|
27804
27840
|
<dd>
|
|
27805
27841
|
|
|
@@ -27861,7 +27897,7 @@ client.payout_subscription.get_payout_subscription(id: 42)
|
|
|
27861
27897
|
</dl>
|
|
27862
27898
|
</details>
|
|
27863
27899
|
|
|
27864
|
-
<details><summary><code>client.payout_subscription.<a href="/lib/payabli/payout_subscription/client.rb">update_payout_subscription</a>(id
|
|
27900
|
+
<details><summary><code>client.payout_subscription.<a href="/lib/payabli/payout_subscription/client.rb">update_payout_subscription</a>(id:, request) -> Payabli::Types::UpdatePayoutSubscriptionResponse</code></summary>
|
|
27865
27901
|
<dl>
|
|
27866
27902
|
<dd>
|
|
27867
27903
|
|
|
@@ -27958,7 +27994,7 @@ client.payout_subscription.update_payout_subscription(
|
|
|
27958
27994
|
</dl>
|
|
27959
27995
|
</details>
|
|
27960
27996
|
|
|
27961
|
-
<details><summary><code>client.payout_subscription.<a href="/lib/payabli/payout_subscription/client.rb">delete_payout_subscription</a>(id) -> Payabli::Types::DeletePayoutSubscriptionResponse</code></summary>
|
|
27997
|
+
<details><summary><code>client.payout_subscription.<a href="/lib/payabli/payout_subscription/client.rb">delete_payout_subscription</a>(id:) -> Payabli::Types::DeletePayoutSubscriptionResponse</code></summary>
|
|
27962
27998
|
<dl>
|
|
27963
27999
|
<dd>
|
|
27964
28000
|
|
|
@@ -28021,7 +28057,7 @@ client.payout_subscription.delete_payout_subscription(id: 42)
|
|
|
28021
28057
|
</details>
|
|
28022
28058
|
|
|
28023
28059
|
## ChargeBacks
|
|
28024
|
-
<details><summary><code>client.charge_backs.<a href="/lib/payabli/charge_backs/client.rb">add_response</a>(id
|
|
28060
|
+
<details><summary><code>client.charge_backs.<a href="/lib/payabli/charge_backs/client.rb">add_response</a>(id:, request) -> Payabli::Types::AddResponseResponse</code></summary>
|
|
28025
28061
|
<dl>
|
|
28026
28062
|
<dd>
|
|
28027
28063
|
|
|
@@ -28126,7 +28162,7 @@ client.charge_backs.add_response(
|
|
|
28126
28162
|
</dl>
|
|
28127
28163
|
</details>
|
|
28128
28164
|
|
|
28129
|
-
<details><summary><code>client.charge_backs.<a href="/lib/payabli/charge_backs/client.rb">get_chargeback</a>(id) -> Payabli::Types::ChargebackQueryRecords</code></summary>
|
|
28165
|
+
<details><summary><code>client.charge_backs.<a href="/lib/payabli/charge_backs/client.rb">get_chargeback</a>(id:) -> Payabli::Types::ChargebackQueryRecords</code></summary>
|
|
28130
28166
|
<dl>
|
|
28131
28167
|
<dd>
|
|
28132
28168
|
|
|
@@ -28168,7 +28204,7 @@ client.charge_backs.get_chargeback(id: 1000000)
|
|
|
28168
28204
|
<dl>
|
|
28169
28205
|
<dd>
|
|
28170
28206
|
|
|
28171
|
-
**id:** `Integer` — ID of the chargeback or return record. This is returned as `chargebackID` in the [ReceivedChargeBack](/
|
|
28207
|
+
**id:** `Integer` — ID of the chargeback or return record. This is returned as `chargebackID` in the [ReceivedChargeBack](/developers/webhooks/payops-chargeback-received) and [ReceivedAchReturn](/developers/webhooks/payops-ach-return-received) webhook notifications.
|
|
28172
28208
|
|
|
28173
28209
|
</dd>
|
|
28174
28210
|
</dl>
|
|
@@ -28188,7 +28224,7 @@ client.charge_backs.get_chargeback(id: 1000000)
|
|
|
28188
28224
|
</dl>
|
|
28189
28225
|
</details>
|
|
28190
28226
|
|
|
28191
|
-
<details><summary><code>client.charge_backs.<a href="/lib/payabli/charge_backs/client.rb">get_chargeback_attachment</a>(id
|
|
28227
|
+
<details><summary><code>client.charge_backs.<a href="/lib/payabli/charge_backs/client.rb">get_chargeback_attachment</a>(id:, file_name:) -> String</code></summary>
|
|
28192
28228
|
<dl>
|
|
28193
28229
|
<dd>
|
|
28194
28230
|
|
|
@@ -28261,3 +28297,1145 @@ client.charge_backs.get_chargeback_attachment(
|
|
|
28261
28297
|
</dl>
|
|
28262
28298
|
</details>
|
|
28263
28299
|
|
|
28300
|
+
## Case Management
|
|
28301
|
+
<details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">validate_bank_account_change</a>(paypoint_id:, request) -> Payabli::Types::PreCreationValidationResult</code></summary>
|
|
28302
|
+
<dl>
|
|
28303
|
+
<dd>
|
|
28304
|
+
|
|
28305
|
+
#### 📝 Description
|
|
28306
|
+
|
|
28307
|
+
<dl>
|
|
28308
|
+
<dd>
|
|
28309
|
+
|
|
28310
|
+
<dl>
|
|
28311
|
+
<dd>
|
|
28312
|
+
|
|
28313
|
+
Validates a bank account change for a paypoint without creating a case.
|
|
28314
|
+
Runs the same checks the create endpoint runs, and returns blocking
|
|
28315
|
+
conditions and warnings. Blocking conditions prevent creation; warnings
|
|
28316
|
+
don't.
|
|
28317
|
+
|
|
28318
|
+
Available to both Platform and Enterprise Partners.
|
|
28319
|
+
</dd>
|
|
28320
|
+
</dl>
|
|
28321
|
+
</dd>
|
|
28322
|
+
</dl>
|
|
28323
|
+
|
|
28324
|
+
#### 🔌 Usage
|
|
28325
|
+
|
|
28326
|
+
<dl>
|
|
28327
|
+
<dd>
|
|
28328
|
+
|
|
28329
|
+
<dl>
|
|
28330
|
+
<dd>
|
|
28331
|
+
|
|
28332
|
+
```ruby
|
|
28333
|
+
client.case_management.validate_bank_account_change(
|
|
28334
|
+
paypoint_id: 3040,
|
|
28335
|
+
routing_number: "123456789",
|
|
28336
|
+
account_number: "987654321",
|
|
28337
|
+
account_type: "checking",
|
|
28338
|
+
bank_account_holder_type: "business",
|
|
28339
|
+
bank_account_function: "Deposits",
|
|
28340
|
+
services: {
|
|
28341
|
+
money_in: ["Ach"],
|
|
28342
|
+
money_out: ["Ach"]
|
|
28343
|
+
}
|
|
28344
|
+
)
|
|
28345
|
+
```
|
|
28346
|
+
</dd>
|
|
28347
|
+
</dl>
|
|
28348
|
+
</dd>
|
|
28349
|
+
</dl>
|
|
28350
|
+
|
|
28351
|
+
#### ⚙️ Parameters
|
|
28352
|
+
|
|
28353
|
+
<dl>
|
|
28354
|
+
<dd>
|
|
28355
|
+
|
|
28356
|
+
<dl>
|
|
28357
|
+
<dd>
|
|
28358
|
+
|
|
28359
|
+
**paypoint_id:** `Integer` — The paypoint's numeric identifier.
|
|
28360
|
+
|
|
28361
|
+
</dd>
|
|
28362
|
+
</dl>
|
|
28363
|
+
|
|
28364
|
+
<dl>
|
|
28365
|
+
<dd>
|
|
28366
|
+
|
|
28367
|
+
**routing_number:** `String` — The 9-digit bank routing number.
|
|
28368
|
+
|
|
28369
|
+
</dd>
|
|
28370
|
+
</dl>
|
|
28371
|
+
|
|
28372
|
+
<dl>
|
|
28373
|
+
<dd>
|
|
28374
|
+
|
|
28375
|
+
**account_number:** `String` — The bank account number (4 to 17 digits).
|
|
28376
|
+
|
|
28377
|
+
</dd>
|
|
28378
|
+
</dl>
|
|
28379
|
+
|
|
28380
|
+
<dl>
|
|
28381
|
+
<dd>
|
|
28382
|
+
|
|
28383
|
+
**account_type:** `String` — The account type. Must be `checking` or `savings`.
|
|
28384
|
+
|
|
28385
|
+
</dd>
|
|
28386
|
+
</dl>
|
|
28387
|
+
|
|
28388
|
+
<dl>
|
|
28389
|
+
<dd>
|
|
28390
|
+
|
|
28391
|
+
**bank_account_holder_type:** `String` — The account holder type. Must be `personal` or `business`.
|
|
28392
|
+
|
|
28393
|
+
</dd>
|
|
28394
|
+
</dl>
|
|
28395
|
+
|
|
28396
|
+
<dl>
|
|
28397
|
+
<dd>
|
|
28398
|
+
|
|
28399
|
+
**bank_account_function:** `Payabli::Types::CaseManagementBankAccountFunction`
|
|
28400
|
+
|
|
28401
|
+
</dd>
|
|
28402
|
+
</dl>
|
|
28403
|
+
|
|
28404
|
+
<dl>
|
|
28405
|
+
<dd>
|
|
28406
|
+
|
|
28407
|
+
**services:** `Payabli::Types::BankAccountServices`
|
|
28408
|
+
|
|
28409
|
+
</dd>
|
|
28410
|
+
</dl>
|
|
28411
|
+
|
|
28412
|
+
<dl>
|
|
28413
|
+
<dd>
|
|
28414
|
+
|
|
28415
|
+
**request_options:** `Payabli::CaseManagement::RequestOptions`
|
|
28416
|
+
|
|
28417
|
+
</dd>
|
|
28418
|
+
</dl>
|
|
28419
|
+
</dd>
|
|
28420
|
+
</dl>
|
|
28421
|
+
|
|
28422
|
+
|
|
28423
|
+
</dd>
|
|
28424
|
+
</dl>
|
|
28425
|
+
</details>
|
|
28426
|
+
|
|
28427
|
+
<details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">create_bank_account_change</a>(paypoint_id:, request) -> Payabli::Types::CaseResponse</code></summary>
|
|
28428
|
+
<dl>
|
|
28429
|
+
<dd>
|
|
28430
|
+
|
|
28431
|
+
#### 📝 Description
|
|
28432
|
+
|
|
28433
|
+
<dl>
|
|
28434
|
+
<dd>
|
|
28435
|
+
|
|
28436
|
+
<dl>
|
|
28437
|
+
<dd>
|
|
28438
|
+
|
|
28439
|
+
Creates a bank-account-change case for a paypoint. The account and
|
|
28440
|
+
routing numbers are validated and tokenized before the case is saved —
|
|
28441
|
+
the raw numbers are never stored or returned. The account holder name is
|
|
28442
|
+
taken from the paypoint's legal name. On success the case is created in
|
|
28443
|
+
`Submitted` and asynchronous verification starts.
|
|
28444
|
+
|
|
28445
|
+
Available to both Platform and Enterprise Partners.
|
|
28446
|
+
</dd>
|
|
28447
|
+
</dl>
|
|
28448
|
+
</dd>
|
|
28449
|
+
</dl>
|
|
28450
|
+
|
|
28451
|
+
#### 🔌 Usage
|
|
28452
|
+
|
|
28453
|
+
<dl>
|
|
28454
|
+
<dd>
|
|
28455
|
+
|
|
28456
|
+
<dl>
|
|
28457
|
+
<dd>
|
|
28458
|
+
|
|
28459
|
+
```ruby
|
|
28460
|
+
client.case_management.create_bank_account_change(
|
|
28461
|
+
paypoint_id: 3040,
|
|
28462
|
+
nickname: "Main Settlement Account",
|
|
28463
|
+
bank_name: "First National Bank",
|
|
28464
|
+
routing_number: "123456789",
|
|
28465
|
+
account_number: "987654321",
|
|
28466
|
+
account_type: "checking",
|
|
28467
|
+
bank_account_holder_type: "business",
|
|
28468
|
+
bank_account_function: "Deposits",
|
|
28469
|
+
services: {
|
|
28470
|
+
money_in: ["Ach"],
|
|
28471
|
+
money_out: ["Ach"]
|
|
28472
|
+
},
|
|
28473
|
+
default: true
|
|
28474
|
+
)
|
|
28475
|
+
```
|
|
28476
|
+
</dd>
|
|
28477
|
+
</dl>
|
|
28478
|
+
</dd>
|
|
28479
|
+
</dl>
|
|
28480
|
+
|
|
28481
|
+
#### ⚙️ Parameters
|
|
28482
|
+
|
|
28483
|
+
<dl>
|
|
28484
|
+
<dd>
|
|
28485
|
+
|
|
28486
|
+
<dl>
|
|
28487
|
+
<dd>
|
|
28488
|
+
|
|
28489
|
+
**paypoint_id:** `Integer` — The paypoint's numeric identifier.
|
|
28490
|
+
|
|
28491
|
+
</dd>
|
|
28492
|
+
</dl>
|
|
28493
|
+
|
|
28494
|
+
<dl>
|
|
28495
|
+
<dd>
|
|
28496
|
+
|
|
28497
|
+
**nickname:** `String` — A label for the account.
|
|
28498
|
+
|
|
28499
|
+
</dd>
|
|
28500
|
+
</dl>
|
|
28501
|
+
|
|
28502
|
+
<dl>
|
|
28503
|
+
<dd>
|
|
28504
|
+
|
|
28505
|
+
**bank_name:** `String` — The name of the bank.
|
|
28506
|
+
|
|
28507
|
+
</dd>
|
|
28508
|
+
</dl>
|
|
28509
|
+
|
|
28510
|
+
<dl>
|
|
28511
|
+
<dd>
|
|
28512
|
+
|
|
28513
|
+
**routing_number:** `String` — The 9-digit bank routing number.
|
|
28514
|
+
|
|
28515
|
+
</dd>
|
|
28516
|
+
</dl>
|
|
28517
|
+
|
|
28518
|
+
<dl>
|
|
28519
|
+
<dd>
|
|
28520
|
+
|
|
28521
|
+
**account_number:** `String` — The bank account number (4 to 17 digits).
|
|
28522
|
+
|
|
28523
|
+
</dd>
|
|
28524
|
+
</dl>
|
|
28525
|
+
|
|
28526
|
+
<dl>
|
|
28527
|
+
<dd>
|
|
28528
|
+
|
|
28529
|
+
**account_type:** `String` — The account type. Must be `checking` or `savings`.
|
|
28530
|
+
|
|
28531
|
+
</dd>
|
|
28532
|
+
</dl>
|
|
28533
|
+
|
|
28534
|
+
<dl>
|
|
28535
|
+
<dd>
|
|
28536
|
+
|
|
28537
|
+
**bank_account_holder_type:** `String` — The account holder type. Must be `personal` or `business`.
|
|
28538
|
+
|
|
28539
|
+
</dd>
|
|
28540
|
+
</dl>
|
|
28541
|
+
|
|
28542
|
+
<dl>
|
|
28543
|
+
<dd>
|
|
28544
|
+
|
|
28545
|
+
**bank_account_function:** `Payabli::Types::CaseManagementBankAccountFunction`
|
|
28546
|
+
|
|
28547
|
+
</dd>
|
|
28548
|
+
</dl>
|
|
28549
|
+
|
|
28550
|
+
<dl>
|
|
28551
|
+
<dd>
|
|
28552
|
+
|
|
28553
|
+
**services:** `Payabli::Types::BankAccountServices`
|
|
28554
|
+
|
|
28555
|
+
</dd>
|
|
28556
|
+
</dl>
|
|
28557
|
+
|
|
28558
|
+
<dl>
|
|
28559
|
+
<dd>
|
|
28560
|
+
|
|
28561
|
+
**default:** `Internal::Types::Boolean` — Whether this is the default account for the selected services.
|
|
28562
|
+
|
|
28563
|
+
</dd>
|
|
28564
|
+
</dl>
|
|
28565
|
+
|
|
28566
|
+
<dl>
|
|
28567
|
+
<dd>
|
|
28568
|
+
|
|
28569
|
+
**schedule_for:** `String`
|
|
28570
|
+
|
|
28571
|
+
When to run the change, as a UTC timestamp (trailing `Z`). Must be at
|
|
28572
|
+
least 1 hour and at most 30 days in the future. Omit to run as soon as
|
|
28573
|
+
the case is approved.
|
|
28574
|
+
|
|
28575
|
+
</dd>
|
|
28576
|
+
</dl>
|
|
28577
|
+
|
|
28578
|
+
<dl>
|
|
28579
|
+
<dd>
|
|
28580
|
+
|
|
28581
|
+
**request_options:** `Payabli::CaseManagement::RequestOptions`
|
|
28582
|
+
|
|
28583
|
+
</dd>
|
|
28584
|
+
</dl>
|
|
28585
|
+
</dd>
|
|
28586
|
+
</dl>
|
|
28587
|
+
|
|
28588
|
+
|
|
28589
|
+
</dd>
|
|
28590
|
+
</dl>
|
|
28591
|
+
</details>
|
|
28592
|
+
|
|
28593
|
+
<details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">get_case</a>(uuid:) -> Payabli::Types::CaseResponse</code></summary>
|
|
28594
|
+
<dl>
|
|
28595
|
+
<dd>
|
|
28596
|
+
|
|
28597
|
+
#### 📝 Description
|
|
28598
|
+
|
|
28599
|
+
<dl>
|
|
28600
|
+
<dd>
|
|
28601
|
+
|
|
28602
|
+
<dl>
|
|
28603
|
+
<dd>
|
|
28604
|
+
|
|
28605
|
+
Returns a case by its UUID, including its current state, parameters,
|
|
28606
|
+
state history, verification metadata, and attachments.
|
|
28607
|
+
|
|
28608
|
+
Available to both Platform and Enterprise Partners.
|
|
28609
|
+
</dd>
|
|
28610
|
+
</dl>
|
|
28611
|
+
</dd>
|
|
28612
|
+
</dl>
|
|
28613
|
+
|
|
28614
|
+
#### 🔌 Usage
|
|
28615
|
+
|
|
28616
|
+
<dl>
|
|
28617
|
+
<dd>
|
|
28618
|
+
|
|
28619
|
+
<dl>
|
|
28620
|
+
<dd>
|
|
28621
|
+
|
|
28622
|
+
```ruby
|
|
28623
|
+
client.case_management.get_case(uuid: "9c2b7e14-3a5f-4d21-b8e0-1f6a4c9d2e70")
|
|
28624
|
+
```
|
|
28625
|
+
</dd>
|
|
28626
|
+
</dl>
|
|
28627
|
+
</dd>
|
|
28628
|
+
</dl>
|
|
28629
|
+
|
|
28630
|
+
#### ⚙️ Parameters
|
|
28631
|
+
|
|
28632
|
+
<dl>
|
|
28633
|
+
<dd>
|
|
28634
|
+
|
|
28635
|
+
<dl>
|
|
28636
|
+
<dd>
|
|
28637
|
+
|
|
28638
|
+
**uuid:** `String` — The case's UUID.
|
|
28639
|
+
|
|
28640
|
+
</dd>
|
|
28641
|
+
</dl>
|
|
28642
|
+
|
|
28643
|
+
<dl>
|
|
28644
|
+
<dd>
|
|
28645
|
+
|
|
28646
|
+
**request_options:** `Payabli::CaseManagement::RequestOptions`
|
|
28647
|
+
|
|
28648
|
+
</dd>
|
|
28649
|
+
</dl>
|
|
28650
|
+
</dd>
|
|
28651
|
+
</dl>
|
|
28652
|
+
|
|
28653
|
+
|
|
28654
|
+
</dd>
|
|
28655
|
+
</dl>
|
|
28656
|
+
</details>
|
|
28657
|
+
|
|
28658
|
+
<details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">list_cases</a>(organization_id:) -> Payabli::Types::CaseListResponse</code></summary>
|
|
28659
|
+
<dl>
|
|
28660
|
+
<dd>
|
|
28661
|
+
|
|
28662
|
+
#### 📝 Description
|
|
28663
|
+
|
|
28664
|
+
<dl>
|
|
28665
|
+
<dd>
|
|
28666
|
+
|
|
28667
|
+
<dl>
|
|
28668
|
+
<dd>
|
|
28669
|
+
|
|
28670
|
+
Lists cases for an organization, climbing the platform org hierarchy.
|
|
28671
|
+
Supports pagination and sorting through query parameters, and filtering
|
|
28672
|
+
through repeatable `parameters[field(op)]=value` query parameters (for
|
|
28673
|
+
example `parameters[state(in)]=Assigned|PendingReview`). Filterable
|
|
28674
|
+
fields include `state`, `caseType`, `paypointId`, `createdAt`,
|
|
28675
|
+
`updatedAt`, `scheduleFor`, and `createdBy`.
|
|
28676
|
+
|
|
28677
|
+
Available to both Platform and Enterprise Partners.
|
|
28678
|
+
</dd>
|
|
28679
|
+
</dl>
|
|
28680
|
+
</dd>
|
|
28681
|
+
</dl>
|
|
28682
|
+
|
|
28683
|
+
#### 🔌 Usage
|
|
28684
|
+
|
|
28685
|
+
<dl>
|
|
28686
|
+
<dd>
|
|
28687
|
+
|
|
28688
|
+
<dl>
|
|
28689
|
+
<dd>
|
|
28690
|
+
|
|
28691
|
+
```ruby
|
|
28692
|
+
client.case_management.list_cases(
|
|
28693
|
+
organization_id: 123,
|
|
28694
|
+
from_record: 0,
|
|
28695
|
+
limit_record: 20
|
|
28696
|
+
)
|
|
28697
|
+
```
|
|
28698
|
+
</dd>
|
|
28699
|
+
</dl>
|
|
28700
|
+
</dd>
|
|
28701
|
+
</dl>
|
|
28702
|
+
|
|
28703
|
+
#### ⚙️ Parameters
|
|
28704
|
+
|
|
28705
|
+
<dl>
|
|
28706
|
+
<dd>
|
|
28707
|
+
|
|
28708
|
+
<dl>
|
|
28709
|
+
<dd>
|
|
28710
|
+
|
|
28711
|
+
**organization_id:** `Integer` — The organization's numeric identifier.
|
|
28712
|
+
|
|
28713
|
+
</dd>
|
|
28714
|
+
</dl>
|
|
28715
|
+
|
|
28716
|
+
<dl>
|
|
28717
|
+
<dd>
|
|
28718
|
+
|
|
28719
|
+
**from_record:** `Integer` — The zero-based index of the first record to return.
|
|
28720
|
+
|
|
28721
|
+
</dd>
|
|
28722
|
+
</dl>
|
|
28723
|
+
|
|
28724
|
+
<dl>
|
|
28725
|
+
<dd>
|
|
28726
|
+
|
|
28727
|
+
**limit_record:** `Integer` — The maximum number of records to return (1 to 200).
|
|
28728
|
+
|
|
28729
|
+
</dd>
|
|
28730
|
+
</dl>
|
|
28731
|
+
|
|
28732
|
+
<dl>
|
|
28733
|
+
<dd>
|
|
28734
|
+
|
|
28735
|
+
**sort_by:** `String` — Sort expression, such as `desc(createdAt)` or `asc(state)`. Defaults to `desc(createdAt)`.
|
|
28736
|
+
|
|
28737
|
+
</dd>
|
|
28738
|
+
</dl>
|
|
28739
|
+
|
|
28740
|
+
<dl>
|
|
28741
|
+
<dd>
|
|
28742
|
+
|
|
28743
|
+
**request_options:** `Payabli::CaseManagement::RequestOptions`
|
|
28744
|
+
|
|
28745
|
+
</dd>
|
|
28746
|
+
</dl>
|
|
28747
|
+
</dd>
|
|
28748
|
+
</dl>
|
|
28749
|
+
|
|
28750
|
+
|
|
28751
|
+
</dd>
|
|
28752
|
+
</dl>
|
|
28753
|
+
</details>
|
|
28754
|
+
|
|
28755
|
+
<details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">list_messages</a>(case_uuid:) -> Payabli::Types::MessagePage</code></summary>
|
|
28756
|
+
<dl>
|
|
28757
|
+
<dd>
|
|
28758
|
+
|
|
28759
|
+
#### 📝 Description
|
|
28760
|
+
|
|
28761
|
+
<dl>
|
|
28762
|
+
<dd>
|
|
28763
|
+
|
|
28764
|
+
<dl>
|
|
28765
|
+
<dd>
|
|
28766
|
+
|
|
28767
|
+
Lists the notes on a case, ordered oldest to newest. Cursor-paginated.
|
|
28768
|
+
|
|
28769
|
+
Available to both Platform and Enterprise Partners.
|
|
28770
|
+
</dd>
|
|
28771
|
+
</dl>
|
|
28772
|
+
</dd>
|
|
28773
|
+
</dl>
|
|
28774
|
+
|
|
28775
|
+
#### 🔌 Usage
|
|
28776
|
+
|
|
28777
|
+
<dl>
|
|
28778
|
+
<dd>
|
|
28779
|
+
|
|
28780
|
+
<dl>
|
|
28781
|
+
<dd>
|
|
28782
|
+
|
|
28783
|
+
```ruby
|
|
28784
|
+
client.case_management.list_messages(case_uuid: "9c2b7e14-3a5f-4d21-b8e0-1f6a4c9d2e70")
|
|
28785
|
+
```
|
|
28786
|
+
</dd>
|
|
28787
|
+
</dl>
|
|
28788
|
+
</dd>
|
|
28789
|
+
</dl>
|
|
28790
|
+
|
|
28791
|
+
#### ⚙️ Parameters
|
|
28792
|
+
|
|
28793
|
+
<dl>
|
|
28794
|
+
<dd>
|
|
28795
|
+
|
|
28796
|
+
<dl>
|
|
28797
|
+
<dd>
|
|
28798
|
+
|
|
28799
|
+
**case_uuid:** `String` — The case's UUID.
|
|
28800
|
+
|
|
28801
|
+
</dd>
|
|
28802
|
+
</dl>
|
|
28803
|
+
|
|
28804
|
+
<dl>
|
|
28805
|
+
<dd>
|
|
28806
|
+
|
|
28807
|
+
**limit:** `Integer` — The maximum number of notes to return (default 50, max 200).
|
|
28808
|
+
|
|
28809
|
+
</dd>
|
|
28810
|
+
</dl>
|
|
28811
|
+
|
|
28812
|
+
<dl>
|
|
28813
|
+
<dd>
|
|
28814
|
+
|
|
28815
|
+
**cursor:** `String` — An opaque cursor for the next page.
|
|
28816
|
+
|
|
28817
|
+
</dd>
|
|
28818
|
+
</dl>
|
|
28819
|
+
|
|
28820
|
+
<dl>
|
|
28821
|
+
<dd>
|
|
28822
|
+
|
|
28823
|
+
**request_options:** `Payabli::CaseManagement::RequestOptions`
|
|
28824
|
+
|
|
28825
|
+
</dd>
|
|
28826
|
+
</dl>
|
|
28827
|
+
</dd>
|
|
28828
|
+
</dl>
|
|
28829
|
+
|
|
28830
|
+
|
|
28831
|
+
</dd>
|
|
28832
|
+
</dl>
|
|
28833
|
+
</details>
|
|
28834
|
+
|
|
28835
|
+
<details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">post_message</a>(case_uuid:, request) -> Payabli::Types::PostedMessage</code></summary>
|
|
28836
|
+
<dl>
|
|
28837
|
+
<dd>
|
|
28838
|
+
|
|
28839
|
+
#### 📝 Description
|
|
28840
|
+
|
|
28841
|
+
<dl>
|
|
28842
|
+
<dd>
|
|
28843
|
+
|
|
28844
|
+
<dl>
|
|
28845
|
+
<dd>
|
|
28846
|
+
|
|
28847
|
+
Adds a note to a case.
|
|
28848
|
+
|
|
28849
|
+
Available to both Platform and Enterprise Partners.
|
|
28850
|
+
|
|
28851
|
+
This endpoint is in development and not yet available for API use. To
|
|
28852
|
+
add a note for now, use Case Management in the
|
|
28853
|
+
[Payabli Portal](/guides/pay-ops-portal-bank-account-changes-manage).
|
|
28854
|
+
To read existing notes on a case, use
|
|
28855
|
+
[List case notes](/developers/api-reference/caseManagement/list-case-notes).
|
|
28856
|
+
</dd>
|
|
28857
|
+
</dl>
|
|
28858
|
+
</dd>
|
|
28859
|
+
</dl>
|
|
28860
|
+
|
|
28861
|
+
#### 🔌 Usage
|
|
28862
|
+
|
|
28863
|
+
<dl>
|
|
28864
|
+
<dd>
|
|
28865
|
+
|
|
28866
|
+
<dl>
|
|
28867
|
+
<dd>
|
|
28868
|
+
|
|
28869
|
+
```ruby
|
|
28870
|
+
client.case_management.post_message(
|
|
28871
|
+
case_uuid: "9c2b7e14-3a5f-4d21-b8e0-1f6a4c9d2e70",
|
|
28872
|
+
content: "Reviewed supporting documents; account ownership confirmed."
|
|
28873
|
+
)
|
|
28874
|
+
```
|
|
28875
|
+
</dd>
|
|
28876
|
+
</dl>
|
|
28877
|
+
</dd>
|
|
28878
|
+
</dl>
|
|
28879
|
+
|
|
28880
|
+
#### ⚙️ Parameters
|
|
28881
|
+
|
|
28882
|
+
<dl>
|
|
28883
|
+
<dd>
|
|
28884
|
+
|
|
28885
|
+
<dl>
|
|
28886
|
+
<dd>
|
|
28887
|
+
|
|
28888
|
+
**case_uuid:** `String` — The case's UUID.
|
|
28889
|
+
|
|
28890
|
+
</dd>
|
|
28891
|
+
</dl>
|
|
28892
|
+
|
|
28893
|
+
<dl>
|
|
28894
|
+
<dd>
|
|
28895
|
+
|
|
28896
|
+
**content:** `String` — The note text (1 to 4000 characters).
|
|
28897
|
+
|
|
28898
|
+
</dd>
|
|
28899
|
+
</dl>
|
|
28900
|
+
|
|
28901
|
+
<dl>
|
|
28902
|
+
<dd>
|
|
28903
|
+
|
|
28904
|
+
**request_options:** `Payabli::CaseManagement::RequestOptions`
|
|
28905
|
+
|
|
28906
|
+
</dd>
|
|
28907
|
+
</dl>
|
|
28908
|
+
</dd>
|
|
28909
|
+
</dl>
|
|
28910
|
+
|
|
28911
|
+
|
|
28912
|
+
</dd>
|
|
28913
|
+
</dl>
|
|
28914
|
+
</details>
|
|
28915
|
+
|
|
28916
|
+
<details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">list_transitions</a>(uuid:) -> Payabli::Types::AvailableTransitionsResponse</code></summary>
|
|
28917
|
+
<dl>
|
|
28918
|
+
<dd>
|
|
28919
|
+
|
|
28920
|
+
#### 📝 Description
|
|
28921
|
+
|
|
28922
|
+
<dl>
|
|
28923
|
+
<dd>
|
|
28924
|
+
|
|
28925
|
+
<dl>
|
|
28926
|
+
<dd>
|
|
28927
|
+
|
|
28928
|
+
Lists the review actions currently available on a case. The list is
|
|
28929
|
+
empty when no user action is available (for example while the case is
|
|
28930
|
+
mid-automation).
|
|
28931
|
+
|
|
28932
|
+
Available to both Platform and Enterprise Partners, though only
|
|
28933
|
+
Enterprise Partners can fire the returned actions.
|
|
28934
|
+
</dd>
|
|
28935
|
+
</dl>
|
|
28936
|
+
</dd>
|
|
28937
|
+
</dl>
|
|
28938
|
+
|
|
28939
|
+
#### 🔌 Usage
|
|
28940
|
+
|
|
28941
|
+
<dl>
|
|
28942
|
+
<dd>
|
|
28943
|
+
|
|
28944
|
+
<dl>
|
|
28945
|
+
<dd>
|
|
28946
|
+
|
|
28947
|
+
```ruby
|
|
28948
|
+
client.case_management.list_transitions(uuid: "9c2b7e14-3a5f-4d21-b8e0-1f6a4c9d2e70")
|
|
28949
|
+
```
|
|
28950
|
+
</dd>
|
|
28951
|
+
</dl>
|
|
28952
|
+
</dd>
|
|
28953
|
+
</dl>
|
|
28954
|
+
|
|
28955
|
+
#### ⚙️ Parameters
|
|
28956
|
+
|
|
28957
|
+
<dl>
|
|
28958
|
+
<dd>
|
|
28959
|
+
|
|
28960
|
+
<dl>
|
|
28961
|
+
<dd>
|
|
28962
|
+
|
|
28963
|
+
**uuid:** `String` — The case's UUID.
|
|
28964
|
+
|
|
28965
|
+
</dd>
|
|
28966
|
+
</dl>
|
|
28967
|
+
|
|
28968
|
+
<dl>
|
|
28969
|
+
<dd>
|
|
28970
|
+
|
|
28971
|
+
**request_options:** `Payabli::CaseManagement::RequestOptions`
|
|
28972
|
+
|
|
28973
|
+
</dd>
|
|
28974
|
+
</dl>
|
|
28975
|
+
</dd>
|
|
28976
|
+
</dl>
|
|
28977
|
+
|
|
28978
|
+
|
|
28979
|
+
</dd>
|
|
28980
|
+
</dl>
|
|
28981
|
+
</details>
|
|
28982
|
+
|
|
28983
|
+
<details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">transition</a>(uuid:, request) -> Payabli::Types::CaseResponse</code></summary>
|
|
28984
|
+
<dl>
|
|
28985
|
+
<dd>
|
|
28986
|
+
|
|
28987
|
+
#### 📝 Description
|
|
28988
|
+
|
|
28989
|
+
<dl>
|
|
28990
|
+
<dd>
|
|
28991
|
+
|
|
28992
|
+
<dl>
|
|
28993
|
+
<dd>
|
|
28994
|
+
|
|
28995
|
+
Fires a review action on a case, such as `Approve`, `Deny`, `Escalate`,
|
|
28996
|
+
or `RequestReview`. Assigning a case uses the dedicated assign endpoint,
|
|
28997
|
+
not this one. Firing an action that isn't valid for the case's current
|
|
28998
|
+
state returns `409`.
|
|
28999
|
+
|
|
29000
|
+
Available to Enterprise Partners only.
|
|
29001
|
+
</dd>
|
|
29002
|
+
</dl>
|
|
29003
|
+
</dd>
|
|
29004
|
+
</dl>
|
|
29005
|
+
|
|
29006
|
+
#### 🔌 Usage
|
|
29007
|
+
|
|
29008
|
+
<dl>
|
|
29009
|
+
<dd>
|
|
29010
|
+
|
|
29011
|
+
<dl>
|
|
29012
|
+
<dd>
|
|
29013
|
+
|
|
29014
|
+
```ruby
|
|
29015
|
+
client.case_management.transition(
|
|
29016
|
+
uuid: "9c2b7e14-3a5f-4d21-b8e0-1f6a4c9d2e70",
|
|
29017
|
+
trigger: "Approve",
|
|
29018
|
+
reason: "Account ownership confirmed with the merchant by phone."
|
|
29019
|
+
)
|
|
29020
|
+
```
|
|
29021
|
+
</dd>
|
|
29022
|
+
</dl>
|
|
29023
|
+
</dd>
|
|
29024
|
+
</dl>
|
|
29025
|
+
|
|
29026
|
+
#### ⚙️ Parameters
|
|
29027
|
+
|
|
29028
|
+
<dl>
|
|
29029
|
+
<dd>
|
|
29030
|
+
|
|
29031
|
+
<dl>
|
|
29032
|
+
<dd>
|
|
29033
|
+
|
|
29034
|
+
**uuid:** `String` — The case's UUID.
|
|
29035
|
+
|
|
29036
|
+
</dd>
|
|
29037
|
+
</dl>
|
|
29038
|
+
|
|
29039
|
+
<dl>
|
|
29040
|
+
<dd>
|
|
29041
|
+
|
|
29042
|
+
**trigger:** `Payabli::Types::CaseTrigger`
|
|
29043
|
+
|
|
29044
|
+
</dd>
|
|
29045
|
+
</dl>
|
|
29046
|
+
|
|
29047
|
+
<dl>
|
|
29048
|
+
<dd>
|
|
29049
|
+
|
|
29050
|
+
**reason:** `String` — The reason for the action.
|
|
29051
|
+
|
|
29052
|
+
</dd>
|
|
29053
|
+
</dl>
|
|
29054
|
+
|
|
29055
|
+
<dl>
|
|
29056
|
+
<dd>
|
|
29057
|
+
|
|
29058
|
+
**decline_reason:** `Payabli::Types::BankReviewDecisionReason` — The decline reason. Required when the trigger is `Deny`, and must be omitted otherwise.
|
|
29059
|
+
|
|
29060
|
+
</dd>
|
|
29061
|
+
</dl>
|
|
29062
|
+
|
|
29063
|
+
<dl>
|
|
29064
|
+
<dd>
|
|
29065
|
+
|
|
29066
|
+
**request_options:** `Payabli::CaseManagement::RequestOptions`
|
|
29067
|
+
|
|
29068
|
+
</dd>
|
|
29069
|
+
</dl>
|
|
29070
|
+
</dd>
|
|
29071
|
+
</dl>
|
|
29072
|
+
|
|
29073
|
+
|
|
29074
|
+
</dd>
|
|
29075
|
+
</dl>
|
|
29076
|
+
</details>
|
|
29077
|
+
|
|
29078
|
+
<details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">assign_case</a>(uuid:, request) -> Payabli::Types::CaseResponse</code></summary>
|
|
29079
|
+
<dl>
|
|
29080
|
+
<dd>
|
|
29081
|
+
|
|
29082
|
+
#### 📝 Description
|
|
29083
|
+
|
|
29084
|
+
<dl>
|
|
29085
|
+
<dd>
|
|
29086
|
+
|
|
29087
|
+
<dl>
|
|
29088
|
+
<dd>
|
|
29089
|
+
|
|
29090
|
+
Assigns a case to a reviewer.
|
|
29091
|
+
|
|
29092
|
+
Available to Enterprise Partners only.
|
|
29093
|
+
</dd>
|
|
29094
|
+
</dl>
|
|
29095
|
+
</dd>
|
|
29096
|
+
</dl>
|
|
29097
|
+
|
|
29098
|
+
#### 🔌 Usage
|
|
29099
|
+
|
|
29100
|
+
<dl>
|
|
29101
|
+
<dd>
|
|
29102
|
+
|
|
29103
|
+
<dl>
|
|
29104
|
+
<dd>
|
|
29105
|
+
|
|
29106
|
+
```ruby
|
|
29107
|
+
client.case_management.assign_case(
|
|
29108
|
+
uuid: "9c2b7e14-3a5f-4d21-b8e0-1f6a4c9d2e70",
|
|
29109
|
+
assignee_id: 4238,
|
|
29110
|
+
reason: "Routing to the risk team for review."
|
|
29111
|
+
)
|
|
29112
|
+
```
|
|
29113
|
+
</dd>
|
|
29114
|
+
</dl>
|
|
29115
|
+
</dd>
|
|
29116
|
+
</dl>
|
|
29117
|
+
|
|
29118
|
+
#### ⚙️ Parameters
|
|
29119
|
+
|
|
29120
|
+
<dl>
|
|
29121
|
+
<dd>
|
|
29122
|
+
|
|
29123
|
+
<dl>
|
|
29124
|
+
<dd>
|
|
29125
|
+
|
|
29126
|
+
**uuid:** `String` — The case's UUID.
|
|
29127
|
+
|
|
29128
|
+
</dd>
|
|
29129
|
+
</dl>
|
|
29130
|
+
|
|
29131
|
+
<dl>
|
|
29132
|
+
<dd>
|
|
29133
|
+
|
|
29134
|
+
**assignee_id:** `Integer` — The numeric id of the reviewer to assign the case to.
|
|
29135
|
+
|
|
29136
|
+
</dd>
|
|
29137
|
+
</dl>
|
|
29138
|
+
|
|
29139
|
+
<dl>
|
|
29140
|
+
<dd>
|
|
29141
|
+
|
|
29142
|
+
**reason:** `String` — An optional reason for the assignment.
|
|
29143
|
+
|
|
29144
|
+
</dd>
|
|
29145
|
+
</dl>
|
|
29146
|
+
|
|
29147
|
+
<dl>
|
|
29148
|
+
<dd>
|
|
29149
|
+
|
|
29150
|
+
**request_options:** `Payabli::CaseManagement::RequestOptions`
|
|
29151
|
+
|
|
29152
|
+
</dd>
|
|
29153
|
+
</dl>
|
|
29154
|
+
</dd>
|
|
29155
|
+
</dl>
|
|
29156
|
+
|
|
29157
|
+
|
|
29158
|
+
</dd>
|
|
29159
|
+
</dl>
|
|
29160
|
+
</details>
|
|
29161
|
+
|
|
29162
|
+
<details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">list_attachments</a>(case_uuid:) -> Internal::Types::Array[Payabli::Types::AttachmentResponse]</code></summary>
|
|
29163
|
+
<dl>
|
|
29164
|
+
<dd>
|
|
29165
|
+
|
|
29166
|
+
#### 📝 Description
|
|
29167
|
+
|
|
29168
|
+
<dl>
|
|
29169
|
+
<dd>
|
|
29170
|
+
|
|
29171
|
+
<dl>
|
|
29172
|
+
<dd>
|
|
29173
|
+
|
|
29174
|
+
Lists the files attached to a case.
|
|
29175
|
+
|
|
29176
|
+
Available to both Platform and Enterprise Partners.
|
|
29177
|
+
</dd>
|
|
29178
|
+
</dl>
|
|
29179
|
+
</dd>
|
|
29180
|
+
</dl>
|
|
29181
|
+
|
|
29182
|
+
#### 🔌 Usage
|
|
29183
|
+
|
|
29184
|
+
<dl>
|
|
29185
|
+
<dd>
|
|
29186
|
+
|
|
29187
|
+
<dl>
|
|
29188
|
+
<dd>
|
|
29189
|
+
|
|
29190
|
+
```ruby
|
|
29191
|
+
client.case_management.list_attachments(case_uuid: "9c2b7e14-3a5f-4d21-b8e0-1f6a4c9d2e70")
|
|
29192
|
+
```
|
|
29193
|
+
</dd>
|
|
29194
|
+
</dl>
|
|
29195
|
+
</dd>
|
|
29196
|
+
</dl>
|
|
29197
|
+
|
|
29198
|
+
#### ⚙️ Parameters
|
|
29199
|
+
|
|
29200
|
+
<dl>
|
|
29201
|
+
<dd>
|
|
29202
|
+
|
|
29203
|
+
<dl>
|
|
29204
|
+
<dd>
|
|
29205
|
+
|
|
29206
|
+
**case_uuid:** `String` — The case's UUID.
|
|
29207
|
+
|
|
29208
|
+
</dd>
|
|
29209
|
+
</dl>
|
|
29210
|
+
|
|
29211
|
+
<dl>
|
|
29212
|
+
<dd>
|
|
29213
|
+
|
|
29214
|
+
**request_options:** `Payabli::CaseManagement::RequestOptions`
|
|
29215
|
+
|
|
29216
|
+
</dd>
|
|
29217
|
+
</dl>
|
|
29218
|
+
</dd>
|
|
29219
|
+
</dl>
|
|
29220
|
+
|
|
29221
|
+
|
|
29222
|
+
</dd>
|
|
29223
|
+
</dl>
|
|
29224
|
+
</details>
|
|
29225
|
+
|
|
29226
|
+
<details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">upload_attachment</a>(case_uuid:, request) -> Payabli::Types::AttachmentResponse</code></summary>
|
|
29227
|
+
<dl>
|
|
29228
|
+
<dd>
|
|
29229
|
+
|
|
29230
|
+
#### 📝 Description
|
|
29231
|
+
|
|
29232
|
+
<dl>
|
|
29233
|
+
<dd>
|
|
29234
|
+
|
|
29235
|
+
<dl>
|
|
29236
|
+
<dd>
|
|
29237
|
+
|
|
29238
|
+
Uploads a file to a case as multipart form data. The maximum size is
|
|
29239
|
+
25 MiB, and the content type must be an allowed type such as PDF, PNG,
|
|
29240
|
+
JPEG, CSV, XLSX, DOCX, or plain text.
|
|
29241
|
+
|
|
29242
|
+
Available to both Platform and Enterprise Partners.
|
|
29243
|
+
</dd>
|
|
29244
|
+
</dl>
|
|
29245
|
+
</dd>
|
|
29246
|
+
</dl>
|
|
29247
|
+
|
|
29248
|
+
#### 🔌 Usage
|
|
29249
|
+
|
|
29250
|
+
<dl>
|
|
29251
|
+
<dd>
|
|
29252
|
+
|
|
29253
|
+
<dl>
|
|
29254
|
+
<dd>
|
|
29255
|
+
|
|
29256
|
+
```ruby
|
|
29257
|
+
client.case_management.upload_attachment(case_uuid: "caseUuid")
|
|
29258
|
+
```
|
|
29259
|
+
</dd>
|
|
29260
|
+
</dl>
|
|
29261
|
+
</dd>
|
|
29262
|
+
</dl>
|
|
29263
|
+
|
|
29264
|
+
#### ⚙️ Parameters
|
|
29265
|
+
|
|
29266
|
+
<dl>
|
|
29267
|
+
<dd>
|
|
29268
|
+
|
|
29269
|
+
<dl>
|
|
29270
|
+
<dd>
|
|
29271
|
+
|
|
29272
|
+
**case_uuid:** `String` — The case's UUID.
|
|
29273
|
+
|
|
29274
|
+
</dd>
|
|
29275
|
+
</dl>
|
|
29276
|
+
|
|
29277
|
+
<dl>
|
|
29278
|
+
<dd>
|
|
29279
|
+
|
|
29280
|
+
**request_options:** `Payabli::CaseManagement::RequestOptions`
|
|
29281
|
+
|
|
29282
|
+
</dd>
|
|
29283
|
+
</dl>
|
|
29284
|
+
</dd>
|
|
29285
|
+
</dl>
|
|
29286
|
+
|
|
29287
|
+
|
|
29288
|
+
</dd>
|
|
29289
|
+
</dl>
|
|
29290
|
+
</details>
|
|
29291
|
+
|
|
29292
|
+
<details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">get_attachment</a>(case_uuid:, attachment_id:) -> String</code></summary>
|
|
29293
|
+
<dl>
|
|
29294
|
+
<dd>
|
|
29295
|
+
|
|
29296
|
+
#### 📝 Description
|
|
29297
|
+
|
|
29298
|
+
<dl>
|
|
29299
|
+
<dd>
|
|
29300
|
+
|
|
29301
|
+
<dl>
|
|
29302
|
+
<dd>
|
|
29303
|
+
|
|
29304
|
+
Streams the file content of an attachment.
|
|
29305
|
+
|
|
29306
|
+
Available to both Platform and Enterprise Partners.
|
|
29307
|
+
</dd>
|
|
29308
|
+
</dl>
|
|
29309
|
+
</dd>
|
|
29310
|
+
</dl>
|
|
29311
|
+
|
|
29312
|
+
#### 🔌 Usage
|
|
29313
|
+
|
|
29314
|
+
<dl>
|
|
29315
|
+
<dd>
|
|
29316
|
+
|
|
29317
|
+
<dl>
|
|
29318
|
+
<dd>
|
|
29319
|
+
|
|
29320
|
+
```ruby
|
|
29321
|
+
client.case_management.get_attachment(
|
|
29322
|
+
case_uuid: "caseUuid",
|
|
29323
|
+
attachment_id: "attachmentId"
|
|
29324
|
+
)
|
|
29325
|
+
```
|
|
29326
|
+
</dd>
|
|
29327
|
+
</dl>
|
|
29328
|
+
</dd>
|
|
29329
|
+
</dl>
|
|
29330
|
+
|
|
29331
|
+
#### ⚙️ Parameters
|
|
29332
|
+
|
|
29333
|
+
<dl>
|
|
29334
|
+
<dd>
|
|
29335
|
+
|
|
29336
|
+
<dl>
|
|
29337
|
+
<dd>
|
|
29338
|
+
|
|
29339
|
+
**case_uuid:** `String` — The case's UUID.
|
|
29340
|
+
|
|
29341
|
+
</dd>
|
|
29342
|
+
</dl>
|
|
29343
|
+
|
|
29344
|
+
<dl>
|
|
29345
|
+
<dd>
|
|
29346
|
+
|
|
29347
|
+
**attachment_id:** `String` — The attachment's UUID.
|
|
29348
|
+
|
|
29349
|
+
</dd>
|
|
29350
|
+
</dl>
|
|
29351
|
+
|
|
29352
|
+
<dl>
|
|
29353
|
+
<dd>
|
|
29354
|
+
|
|
29355
|
+
**request_options:** `Payabli::CaseManagement::RequestOptions`
|
|
29356
|
+
|
|
29357
|
+
</dd>
|
|
29358
|
+
</dl>
|
|
29359
|
+
</dd>
|
|
29360
|
+
</dl>
|
|
29361
|
+
|
|
29362
|
+
|
|
29363
|
+
</dd>
|
|
29364
|
+
</dl>
|
|
29365
|
+
</details>
|
|
29366
|
+
|
|
29367
|
+
<details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">delete_attachment</a>(case_uuid:, attachment_id:) -> </code></summary>
|
|
29368
|
+
<dl>
|
|
29369
|
+
<dd>
|
|
29370
|
+
|
|
29371
|
+
#### 📝 Description
|
|
29372
|
+
|
|
29373
|
+
<dl>
|
|
29374
|
+
<dd>
|
|
29375
|
+
|
|
29376
|
+
<dl>
|
|
29377
|
+
<dd>
|
|
29378
|
+
|
|
29379
|
+
Deletes an attachment from a case.
|
|
29380
|
+
|
|
29381
|
+
Available to both Platform and Enterprise Partners.
|
|
29382
|
+
</dd>
|
|
29383
|
+
</dl>
|
|
29384
|
+
</dd>
|
|
29385
|
+
</dl>
|
|
29386
|
+
|
|
29387
|
+
#### 🔌 Usage
|
|
29388
|
+
|
|
29389
|
+
<dl>
|
|
29390
|
+
<dd>
|
|
29391
|
+
|
|
29392
|
+
<dl>
|
|
29393
|
+
<dd>
|
|
29394
|
+
|
|
29395
|
+
```ruby
|
|
29396
|
+
client.case_management.delete_attachment(
|
|
29397
|
+
case_uuid: "caseUuid",
|
|
29398
|
+
attachment_id: "attachmentId"
|
|
29399
|
+
)
|
|
29400
|
+
```
|
|
29401
|
+
</dd>
|
|
29402
|
+
</dl>
|
|
29403
|
+
</dd>
|
|
29404
|
+
</dl>
|
|
29405
|
+
|
|
29406
|
+
#### ⚙️ Parameters
|
|
29407
|
+
|
|
29408
|
+
<dl>
|
|
29409
|
+
<dd>
|
|
29410
|
+
|
|
29411
|
+
<dl>
|
|
29412
|
+
<dd>
|
|
29413
|
+
|
|
29414
|
+
**case_uuid:** `String` — The case's UUID.
|
|
29415
|
+
|
|
29416
|
+
</dd>
|
|
29417
|
+
</dl>
|
|
29418
|
+
|
|
29419
|
+
<dl>
|
|
29420
|
+
<dd>
|
|
29421
|
+
|
|
29422
|
+
**attachment_id:** `String` — The attachment's UUID.
|
|
29423
|
+
|
|
29424
|
+
</dd>
|
|
29425
|
+
</dl>
|
|
29426
|
+
|
|
29427
|
+
<dl>
|
|
29428
|
+
<dd>
|
|
29429
|
+
|
|
29430
|
+
**request_options:** `Payabli::CaseManagement::RequestOptions`
|
|
29431
|
+
|
|
29432
|
+
</dd>
|
|
29433
|
+
</dl>
|
|
29434
|
+
</dd>
|
|
29435
|
+
</dl>
|
|
29436
|
+
|
|
29437
|
+
|
|
29438
|
+
</dd>
|
|
29439
|
+
</dl>
|
|
29440
|
+
</details>
|
|
29441
|
+
|