payabli 3.0.6 → 3.0.8
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 +7 -6
- data/lib/payabli/bill/client.rb +8 -2
- data/lib/payabli/billing/client.rb +129 -0
- data/lib/payabli/billing/types/get_profile_billing_request_entity_type.rb +16 -0
- data/lib/payabli/billing/types/get_profile_billing_request_service_group.rb +14 -0
- data/lib/payabli/billing/types/list_billing_profiles_request.rb +23 -0
- data/lib/payabli/boarding/client.rb +4 -1
- 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/client.rb +11 -1
- data/lib/payabli/customer/client.rb +4 -1
- data/lib/payabli/hosted_payment_pages/client.rb +4 -1
- data/lib/payabli/internal/http/raw_client.rb +15 -2
- data/lib/payabli/internal/json/request.rb +7 -5
- data/lib/payabli/line_item/client.rb +4 -1
- data/lib/payabli/money_in/client.rb +55 -8
- data/lib/payabli/money_out/client.rb +17 -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 +10 -7
- data/lib/payabli/ocr/client.rb +8 -2
- data/lib/payabli/organization/client.rb +5 -5
- data/lib/payabli/organization/types/organization_data.rb +2 -2
- data/lib/payabli/payment_link/client.rb +8 -2
- data/lib/payabli/paypoint/client.rb +4 -1
- data/lib/payabli/types/attachment_response.rb +24 -0
- data/lib/payabli/types/auth_capture_payout_response_data.rb +1 -1
- 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/billable_event.rb +29 -0
- data/lib/payabli/types/billing_entity.rb +13 -0
- data/lib/payabli/types/billing_entity_named.rb +13 -0
- data/lib/payabli/types/billing_profile_query_response.rb +14 -0
- data/lib/payabli/types/billing_profile_record.rb +32 -0
- data/lib/payabli/types/billing_profile_response.rb +31 -0
- data/lib/payabli/types/billing_profile_summary.rb +16 -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/collection_schedule_value.rb +23 -0
- data/lib/payabli/types/device_query_record.rb +8 -0
- data/lib/payabli/types/entities_assigned.rb +17 -0
- data/lib/payabli/types/entity_type_name.rb +17 -0
- data/lib/payabli/types/entity_type_value.rb +23 -0
- data/lib/payabli/types/event_group_value.rb +23 -0
- data/lib/payabli/types/event_source_value.rb +23 -0
- data/lib/payabli/types/event_type_value.rb +23 -0
- data/lib/payabli/types/fee_schedule.rb +47 -0
- data/lib/payabli/types/fee_type_name.rb +12 -0
- data/lib/payabli/types/fee_type_value.rb +23 -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/passthrough_value.rb +23 -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/query_payout_transaction_records_item.rb +2 -0
- data/lib/payabli/types/query_payout_transaction_records_item_allowed_actions_item.rb +13 -0
- data/lib/payabli/types/region_type_value.rb +23 -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/service_group_value.rb +23 -0
- data/lib/payabli/types/service_type_value.rb +23 -0
- data/lib/payabli/types/service_value.rb +23 -0
- data/lib/payabli/types/service_vertical_name.rb +13 -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 +8 -2
- data/lib/payabli/vendor/client.rb +8 -2
- data/lib/payabli/version.rb +1 -1
- data/lib/payabli.rb +64 -0
- data/reference.md +1734 -421
- data/wiremock/wiremock-mappings.json +502 -9
- metadata +66 -2
data/reference.md
CHANGED
|
@@ -811,9 +811,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
811
811
|
<Info>
|
|
812
812
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
813
813
|
|
|
814
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response isn't filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
815
|
-
|
|
816
|
-
For example:
|
|
814
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response isn't filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
817
815
|
|
|
818
816
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
819
817
|
|
|
@@ -823,7 +821,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
823
821
|
</Info>
|
|
824
822
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
825
823
|
|
|
826
|
-
|
|
824
|
+
**Accepted field names:**
|
|
827
825
|
- `frequency` (`in`, `nin`, `ne`, `eq`)
|
|
828
826
|
- `method` (`in`, `nin`, `eq`, `ne`)
|
|
829
827
|
- `event` (`in`, `nin`, `eq`, `ne`)
|
|
@@ -834,7 +832,7 @@ List of field names accepted:
|
|
|
834
832
|
- `approvalUserEmail` (`eq`, `ne`)
|
|
835
833
|
- `scheduleId` (`ne`, `eq`)
|
|
836
834
|
|
|
837
|
-
|
|
835
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
838
836
|
- `eq` or empty => equal
|
|
839
837
|
- `gt` => greater than
|
|
840
838
|
- `ge` => greater or equal
|
|
@@ -846,7 +844,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
846
844
|
- `in` => inside array
|
|
847
845
|
- `nin` => not inside array
|
|
848
846
|
|
|
849
|
-
|
|
847
|
+
Accepted parameters:
|
|
850
848
|
- `limitRecord` : max number of records for query (default="20", "0" or negative value for all)
|
|
851
849
|
- `fromRecord` : initial record in query
|
|
852
850
|
Example: `totalAmount(gt)=20` returns all records with a `totalAmount` that's greater than 20.00
|
|
@@ -962,9 +960,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
962
960
|
<Info>
|
|
963
961
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
964
962
|
|
|
965
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response isn't filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
966
|
-
|
|
967
|
-
For example:
|
|
963
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response isn't filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
968
964
|
|
|
969
965
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
970
966
|
|
|
@@ -974,7 +970,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
974
970
|
</Info>
|
|
975
971
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
976
972
|
|
|
977
|
-
|
|
973
|
+
**Accepted field names:**
|
|
978
974
|
- `frequency` (in, nin, ne, eq)
|
|
979
975
|
- `method` (in, nin, eq, ne)
|
|
980
976
|
- `event` (in, nin, eq, ne)
|
|
@@ -984,7 +980,7 @@ List of field names accepted:
|
|
|
984
980
|
- `approvalUserId` (eq, ne)
|
|
985
981
|
- `approvalUserEmail` (eq, ne)
|
|
986
982
|
|
|
987
|
-
|
|
983
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
988
984
|
- eq or empty => equal
|
|
989
985
|
- gt => greater than
|
|
990
986
|
- ge => greater or equal
|
|
@@ -996,7 +992,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
996
992
|
- in => inside array
|
|
997
993
|
- nin => not inside array
|
|
998
994
|
|
|
999
|
-
|
|
995
|
+
Accepted parameters:
|
|
1000
996
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
1001
997
|
- fromRecord : initial record in query
|
|
1002
998
|
|
|
@@ -1531,7 +1527,7 @@ client.check_capture.check_processing(
|
|
|
1531
1527
|
<dl>
|
|
1532
1528
|
<dd>
|
|
1533
1529
|
|
|
1534
|
-
**front_image:** `String` — Base64-encoded front check image. Must be JPEG or PNG format and less than 1MB. Image must show the entire check
|
|
1530
|
+
**front_image:** `String` — Base64-encoded front check image. Must be JPEG or PNG format and less than 1MB. Image must show the entire check with no partial, blurry, or illegible portions.
|
|
1535
1531
|
|
|
1536
1532
|
</dd>
|
|
1537
1533
|
</dl>
|
|
@@ -1539,7 +1535,7 @@ client.check_capture.check_processing(
|
|
|
1539
1535
|
<dl>
|
|
1540
1536
|
<dd>
|
|
1541
1537
|
|
|
1542
|
-
**rear_image:** `String` — Base64-encoded rear check image. Must be JPEG or PNG format and less than 1MB. Image must show the entire check
|
|
1538
|
+
**rear_image:** `String` — Base64-encoded rear check image. Must be JPEG or PNG format and less than 1MB. Image must show the entire check with no partial, blurry, or illegible portions.
|
|
1543
1539
|
|
|
1544
1540
|
</dd>
|
|
1545
1541
|
</dl>
|
|
@@ -3132,7 +3128,25 @@ This is the v2 version of the refund endpoint, and returns the unified response
|
|
|
3132
3128
|
<dd>
|
|
3133
3129
|
|
|
3134
3130
|
```ruby
|
|
3135
|
-
client.money_in.refundv_2(
|
|
3131
|
+
client.money_in.refundv_2(
|
|
3132
|
+
trans_id: "10-3ffa27df-b171-44e0-b251-e95fbfc7a723",
|
|
3133
|
+
amount: 100,
|
|
3134
|
+
order_description: "Materials deposit",
|
|
3135
|
+
refund_details: {
|
|
3136
|
+
split_refunding: [{
|
|
3137
|
+
origination_entry_point: "495147f647",
|
|
3138
|
+
account_id: "187-342",
|
|
3139
|
+
description: "Refunding undelivered materials",
|
|
3140
|
+
amount: 60
|
|
3141
|
+
}, {
|
|
3142
|
+
origination_entry_point: "8cfec329267",
|
|
3143
|
+
account_id: "187-343",
|
|
3144
|
+
description: "Refunding deposit for undelivered materials",
|
|
3145
|
+
amount: 40
|
|
3146
|
+
}]
|
|
3147
|
+
},
|
|
3148
|
+
source: "api"
|
|
3149
|
+
)
|
|
3136
3150
|
```
|
|
3137
3151
|
</dd>
|
|
3138
3152
|
</dl>
|
|
@@ -3192,7 +3206,7 @@ Refund a transaction that has settled and send money back to the account holder.
|
|
|
3192
3206
|
This is the v2 version of the refund endpoint, and returns the unified response format. See [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for more information.
|
|
3193
3207
|
|
|
3194
3208
|
<Note>
|
|
3195
|
-
|
|
3209
|
+
For a standard refund, whether full (`amount` set to 0) or partial, send no request body. Include a request body only to refund a split-funded transaction, with split instructions in `refundDetails`.
|
|
3196
3210
|
</Note>
|
|
3197
3211
|
</dd>
|
|
3198
3212
|
</dl>
|
|
@@ -3210,7 +3224,22 @@ This is the v2 version of the refund endpoint, and returns the unified response
|
|
|
3210
3224
|
```ruby
|
|
3211
3225
|
client.money_in.refundv_2_amount(
|
|
3212
3226
|
trans_id: "10-3ffa27df-b171-44e0-b251-e95fbfc7a723",
|
|
3213
|
-
amount:
|
|
3227
|
+
amount: 70,
|
|
3228
|
+
order_description: "Materials deposit",
|
|
3229
|
+
refund_details: {
|
|
3230
|
+
split_refunding: [{
|
|
3231
|
+
origination_entry_point: "495147f647",
|
|
3232
|
+
account_id: "187-342",
|
|
3233
|
+
description: "Refunding undelivered materials",
|
|
3234
|
+
amount: 40
|
|
3235
|
+
}, {
|
|
3236
|
+
origination_entry_point: "8cfec329267",
|
|
3237
|
+
account_id: "187-343",
|
|
3238
|
+
description: "Refunding deposit for undelivered materials",
|
|
3239
|
+
amount: 30
|
|
3240
|
+
}]
|
|
3241
|
+
},
|
|
3242
|
+
source: "api"
|
|
3214
3243
|
)
|
|
3215
3244
|
```
|
|
3216
3245
|
</dd>
|
|
@@ -4444,7 +4473,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
4444
4473
|
|
|
4445
4474
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
4446
4475
|
|
|
4447
|
-
|
|
4476
|
+
Accepted field names:
|
|
4448
4477
|
|
|
4449
4478
|
- `invoiceDate` (gt, ge, lt, le, eq, ne)
|
|
4450
4479
|
- `dueDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -4485,7 +4514,7 @@ List of field names accepted:
|
|
|
4485
4514
|
- `orgName` (ne, eq, ct, nct)
|
|
4486
4515
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
4487
4516
|
|
|
4488
|
-
|
|
4517
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
4489
4518
|
|
|
4490
4519
|
- eq or empty => equal
|
|
4491
4520
|
- gt => greater than
|
|
@@ -4498,7 +4527,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
4498
4527
|
- in => inside array
|
|
4499
4528
|
- nin => not inside array
|
|
4500
4529
|
|
|
4501
|
-
|
|
4530
|
+
Accepted parameters:
|
|
4502
4531
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
4503
4532
|
- fromRecord : initial record in query
|
|
4504
4533
|
|
|
@@ -4615,7 +4644,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
4615
4644
|
|
|
4616
4645
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
4617
4646
|
|
|
4618
|
-
|
|
4647
|
+
Accepted field names:
|
|
4619
4648
|
|
|
4620
4649
|
- `invoiceDate` (gt, ge, lt, le, eq, ne)
|
|
4621
4650
|
- `dueDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -4656,7 +4685,7 @@ List of field names accepted:
|
|
|
4656
4685
|
- `orgName` (ne, eq, ct, nct)
|
|
4657
4686
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
4658
4687
|
|
|
4659
|
-
|
|
4688
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
4660
4689
|
|
|
4661
4690
|
- eq or empty => equal
|
|
4662
4691
|
- gt => greater than
|
|
@@ -4669,7 +4698,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
4669
4698
|
- in => inside array
|
|
4670
4699
|
- nin => not inside array
|
|
4671
4700
|
|
|
4672
|
-
|
|
4701
|
+
Accepted parameters:
|
|
4673
4702
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
4674
4703
|
- fromRecord : initial record in query
|
|
4675
4704
|
|
|
@@ -8147,9 +8176,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
8147
8176
|
<Info>
|
|
8148
8177
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
8149
8178
|
|
|
8150
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
8151
|
-
|
|
8152
|
-
For example:
|
|
8179
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
8153
8180
|
|
|
8154
8181
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
8155
8182
|
|
|
@@ -8160,7 +8187,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
8160
8187
|
|
|
8161
8188
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
8162
8189
|
|
|
8163
|
-
**
|
|
8190
|
+
**Accepted field names:**
|
|
8164
8191
|
|
|
8165
8192
|
- `settlementDate` (gt, ge, lt, le, eq, ne)
|
|
8166
8193
|
- `depositDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -8200,7 +8227,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
8200
8227
|
- `batchId` (ct, nct, eq, neq)
|
|
8201
8228
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
8202
8229
|
|
|
8203
|
-
**
|
|
8230
|
+
**Accepted comparison operators:**
|
|
8204
8231
|
- `eq` or empty => equal
|
|
8205
8232
|
- `gt` => greater than
|
|
8206
8233
|
- `ge` => greater or equal
|
|
@@ -8212,7 +8239,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
8212
8239
|
- `in` => inside array separated by "|"
|
|
8213
8240
|
- `nin` => not inside array separated by "|"
|
|
8214
8241
|
|
|
8215
|
-
**
|
|
8242
|
+
**Accepted parameters:**
|
|
8216
8243
|
|
|
8217
8244
|
- `limitRecord`: max number of records for query (default="20", "0" or negative value for all)
|
|
8218
8245
|
- `fromRecord`: initial record in query
|
|
@@ -8330,9 +8357,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
8330
8357
|
<Info>
|
|
8331
8358
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
8332
8359
|
|
|
8333
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
8334
|
-
|
|
8335
|
-
For example:
|
|
8360
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
8336
8361
|
|
|
8337
8362
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
8338
8363
|
|
|
@@ -8342,7 +8367,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
8342
8367
|
</Info>
|
|
8343
8368
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
8344
8369
|
|
|
8345
|
-
**
|
|
8370
|
+
**Accepted field names:**
|
|
8346
8371
|
|
|
8347
8372
|
- `settlementDate` (gt, ge, lt, le, eq, ne)
|
|
8348
8373
|
- `depositDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -8382,7 +8407,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
8382
8407
|
- `batchId` (ct, nct, eq, neq)
|
|
8383
8408
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
8384
8409
|
|
|
8385
|
-
**
|
|
8410
|
+
**Accepted comparison operators:**
|
|
8386
8411
|
- `eq` or empty => equal
|
|
8387
8412
|
- `gt` => greater than
|
|
8388
8413
|
- `ge` => greater or equal
|
|
@@ -8394,7 +8419,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
8394
8419
|
- `in` => inside array separated by "|"
|
|
8395
8420
|
- `nin` => not inside array separated by "|"
|
|
8396
8421
|
|
|
8397
|
-
**
|
|
8422
|
+
**Accepted parameters:**
|
|
8398
8423
|
|
|
8399
8424
|
- `limitRecord`: max number of records for query (default="20", "0" or negative value for all)
|
|
8400
8425
|
- `fromRecord`: initial record in query
|
|
@@ -8512,9 +8537,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
8512
8537
|
<Info>
|
|
8513
8538
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
8514
8539
|
|
|
8515
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
8516
|
-
|
|
8517
|
-
For example:
|
|
8540
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
8518
8541
|
|
|
8519
8542
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
8520
8543
|
|
|
@@ -8525,7 +8548,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
8525
8548
|
|
|
8526
8549
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
8527
8550
|
|
|
8528
|
-
**
|
|
8551
|
+
**Accepted field names:**
|
|
8529
8552
|
|
|
8530
8553
|
- `batchDate` (gt, ge, lt, le, eq, ne)
|
|
8531
8554
|
- `batchNumber` (ne, eq)
|
|
@@ -8557,7 +8580,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
8557
8580
|
- `processor` (ne, eq, ct, nct)
|
|
8558
8581
|
- `transferStatus` (ne, eq, in, nin)
|
|
8559
8582
|
|
|
8560
|
-
**
|
|
8583
|
+
**Accepted parameters:**
|
|
8561
8584
|
- `limitRecord`: max number of records for query (default="20", "0" or negative value for all)
|
|
8562
8585
|
- `fromRecord`: initial record in query
|
|
8563
8586
|
|
|
@@ -8674,9 +8697,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
8674
8697
|
<Info>
|
|
8675
8698
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
8676
8699
|
|
|
8677
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
8678
|
-
|
|
8679
|
-
For example:
|
|
8700
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
8680
8701
|
|
|
8681
8702
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
8682
8703
|
|
|
@@ -8687,7 +8708,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
8687
8708
|
|
|
8688
8709
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
8689
8710
|
|
|
8690
|
-
**
|
|
8711
|
+
**Accepted field names:**
|
|
8691
8712
|
|
|
8692
8713
|
- `batchDate` (gt, ge, lt, le, eq, ne)
|
|
8693
8714
|
- `batchNumber` (ne, eq)
|
|
@@ -8719,7 +8740,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
8719
8740
|
- `processor` (ne, eq, ct, nct)
|
|
8720
8741
|
- `transferStatus` (ne, eq, in, nin)
|
|
8721
8742
|
|
|
8722
|
-
**
|
|
8743
|
+
**Accepted parameters:**
|
|
8723
8744
|
- `limitRecord`: max number of records for query (default="20", "0" or negative value for all)
|
|
8724
8745
|
- `fromRecord`: initial record in query
|
|
8725
8746
|
|
|
@@ -8834,7 +8855,7 @@ client.query.list_batches_out(
|
|
|
8834
8855
|
|
|
8835
8856
|
Collection of field names, conditions, and values used to filter the query. See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
8836
8857
|
|
|
8837
|
-
**
|
|
8858
|
+
**Accepted field names**:
|
|
8838
8859
|
|
|
8839
8860
|
- `batchDate` (gt, ge, lt, le, eq, ne)
|
|
8840
8861
|
- `batchNumber` (ne, eq)
|
|
@@ -8959,9 +8980,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
8959
8980
|
<Info>
|
|
8960
8981
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
8961
8982
|
|
|
8962
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
8963
|
-
|
|
8964
|
-
For example:
|
|
8983
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
8965
8984
|
|
|
8966
8985
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
8967
8986
|
|
|
@@ -8972,7 +8991,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
8972
8991
|
|
|
8973
8992
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
8974
8993
|
|
|
8975
|
-
**
|
|
8994
|
+
**Accepted field names**:
|
|
8976
8995
|
|
|
8977
8996
|
- `batchDate` (gt, ge, lt, le, eq, ne)
|
|
8978
8997
|
- `batchNumber` (ne, eq)
|
|
@@ -9097,9 +9116,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
9097
9116
|
<Info>
|
|
9098
9117
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
9099
9118
|
|
|
9100
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
9101
|
-
|
|
9102
|
-
For example:
|
|
9119
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
9103
9120
|
|
|
9104
9121
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
9105
9122
|
|
|
@@ -9109,7 +9126,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
9109
9126
|
</Info>
|
|
9110
9127
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
9111
9128
|
|
|
9112
|
-
**
|
|
9129
|
+
**Accepted field names:**
|
|
9113
9130
|
- `chargebackDate` (gt, ge, lt, le, eq, ne)
|
|
9114
9131
|
- `transId` (ne, eq, ct, nct)
|
|
9115
9132
|
- `method` (in, nin, eq, ne)
|
|
@@ -9147,7 +9164,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
9147
9164
|
- `orgName` (ne, eq, ct, nct)
|
|
9148
9165
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
9149
9166
|
|
|
9150
|
-
**
|
|
9167
|
+
**Accepted comparison operators - enclosed between parentheses:**
|
|
9151
9168
|
- `eq` or empty => equal
|
|
9152
9169
|
- `gt` => greater than
|
|
9153
9170
|
- `ge` => greater or equal
|
|
@@ -9159,7 +9176,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
9159
9176
|
- `in` => inside array separated by "|"
|
|
9160
9177
|
- `nin` => not inside array separated by "|"
|
|
9161
9178
|
|
|
9162
|
-
**
|
|
9179
|
+
**Accepted parameters:**
|
|
9163
9180
|
- `limitRecord`: max number of records for query (default="20", "0" or negative value for all)
|
|
9164
9181
|
- `fromRecord`: initial record in query
|
|
9165
9182
|
|
|
@@ -9277,9 +9294,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
9277
9294
|
<Info>
|
|
9278
9295
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
9279
9296
|
|
|
9280
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
9281
|
-
|
|
9282
|
-
For example:
|
|
9297
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
9283
9298
|
|
|
9284
9299
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
9285
9300
|
|
|
@@ -9288,7 +9303,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
9288
9303
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
9289
9304
|
</Info> See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
9290
9305
|
|
|
9291
|
-
**
|
|
9306
|
+
**Accepted field names:**
|
|
9292
9307
|
|
|
9293
9308
|
- `chargebackDate` (gt, ge, lt, le, eq, ne)
|
|
9294
9309
|
- `transId` (ne, eq, ct, nct)
|
|
@@ -9327,7 +9342,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
9327
9342
|
- `orgName` (ne, eq, ct, nct)
|
|
9328
9343
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
9329
9344
|
|
|
9330
|
-
**
|
|
9345
|
+
**Accepted comparison operators - enclosed between parentheses:**
|
|
9331
9346
|
|
|
9332
9347
|
- `eq` or empty => equal
|
|
9333
9348
|
- `gt` => greater than
|
|
@@ -9340,7 +9355,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
9340
9355
|
- `in` => inside array separated by "|"
|
|
9341
9356
|
- `nin` => not inside array separated by "|"
|
|
9342
9357
|
|
|
9343
|
-
**
|
|
9358
|
+
**Accepted parameters:**
|
|
9344
9359
|
- `limitRecord`: max number of records for query (default="20", "0" or negative value for all)
|
|
9345
9360
|
- `fromRecord`: initial record in query
|
|
9346
9361
|
|
|
@@ -9457,9 +9472,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
9457
9472
|
<Info>
|
|
9458
9473
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
9459
9474
|
|
|
9460
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
9461
|
-
|
|
9462
|
-
For example:
|
|
9475
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
9463
9476
|
|
|
9464
9477
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
9465
9478
|
|
|
@@ -9469,7 +9482,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
9469
9482
|
</Info>
|
|
9470
9483
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more details.
|
|
9471
9484
|
|
|
9472
|
-
**
|
|
9485
|
+
**Accepted field names:**
|
|
9473
9486
|
|
|
9474
9487
|
- `createdDate` (gt, ge, lt, le, eq, ne)
|
|
9475
9488
|
- `customernumber` (ne, eq, ct, nct)
|
|
@@ -9499,7 +9512,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
9499
9512
|
- `paypointDba` (ne, eq, ct, nct)
|
|
9500
9513
|
- `orgName` (ne, eq, ct, nct)
|
|
9501
9514
|
|
|
9502
|
-
**
|
|
9515
|
+
**Accepted comparison operators:**
|
|
9503
9516
|
|
|
9504
9517
|
- `eq` or empty => equal
|
|
9505
9518
|
- `gt` => greater than
|
|
@@ -9512,7 +9525,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
9512
9525
|
- `in` => inside array separated by "|"
|
|
9513
9526
|
- `nin` => not inside array separated by "|"
|
|
9514
9527
|
|
|
9515
|
-
**Accepted
|
|
9528
|
+
**Accepted parameters:**
|
|
9516
9529
|
- `limitRecord`: Max number of records for query (default="20", "0" or negative value for all)
|
|
9517
9530
|
- `fromRecord`: Initial record in query
|
|
9518
9531
|
|
|
@@ -9630,9 +9643,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
9630
9643
|
<Info>
|
|
9631
9644
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
9632
9645
|
|
|
9633
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
9634
|
-
|
|
9635
|
-
For example:
|
|
9646
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
9636
9647
|
|
|
9637
9648
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
9638
9649
|
|
|
@@ -9642,7 +9653,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
9642
9653
|
</Info>
|
|
9643
9654
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more details.
|
|
9644
9655
|
|
|
9645
|
-
**
|
|
9656
|
+
**Accepted field names:**
|
|
9646
9657
|
|
|
9647
9658
|
- `createdDate` (gt, ge, lt, le, eq, ne)
|
|
9648
9659
|
- `customernumber` (ne, eq, ct, nct)
|
|
@@ -9672,7 +9683,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
9672
9683
|
- `paypointDba` (ne, eq, ct, nct)
|
|
9673
9684
|
- `orgName` (ne, eq, ct, nct)
|
|
9674
9685
|
|
|
9675
|
-
**
|
|
9686
|
+
**Accepted comparison operators:**
|
|
9676
9687
|
|
|
9677
9688
|
- `eq` or empty => equal
|
|
9678
9689
|
- `gt` => greater than
|
|
@@ -9685,7 +9696,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
9685
9696
|
- `in` => inside array separated by "|"
|
|
9686
9697
|
- `nin` => not inside array separated by "|"
|
|
9687
9698
|
|
|
9688
|
-
**Accepted
|
|
9699
|
+
**Accepted parameters:**
|
|
9689
9700
|
- `limitRecord`: Max number of records for query (default="20", "0" or negative value for all)
|
|
9690
9701
|
- `fromRecord`: Initial record in query
|
|
9691
9702
|
|
|
@@ -9805,9 +9816,7 @@ the query.
|
|
|
9805
9816
|
<Info>
|
|
9806
9817
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
9807
9818
|
|
|
9808
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
9809
|
-
|
|
9810
|
-
For example:
|
|
9819
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
9811
9820
|
|
|
9812
9821
|
--url https://api-sandbox.payabli.com/api/Query/devices/8cfec329267?parameters=status=1&limitRecord=20
|
|
9813
9822
|
|
|
@@ -9820,7 +9829,7 @@ See [Filters and Conditions
|
|
|
9820
9829
|
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
|
|
9821
9830
|
for more information.
|
|
9822
9831
|
|
|
9823
|
-
**
|
|
9832
|
+
**Accepted field names:**
|
|
9824
9833
|
|
|
9825
9834
|
|
|
9826
9835
|
- `deviceId` (eq, ne, ct, nct)
|
|
@@ -9869,8 +9878,16 @@ for more information.
|
|
|
9869
9878
|
|
|
9870
9879
|
- `parentOrgName` (eq, ne, ct, nct)
|
|
9871
9880
|
|
|
9881
|
+
- `paypointLogo` (eq, ne, ct, nct)
|
|
9872
9882
|
|
|
9873
|
-
|
|
9883
|
+
- `parentOrgLogo` (eq, ne, ct, nct)
|
|
9884
|
+
|
|
9885
|
+
- `transactionCount` (eq, ne, gt, ge, lt, le)
|
|
9886
|
+
|
|
9887
|
+
- `volumeProcessed` (eq, ne, gt, ge, lt, le)
|
|
9888
|
+
|
|
9889
|
+
|
|
9890
|
+
**Accepted comparison operators:**
|
|
9874
9891
|
|
|
9875
9892
|
- `eq` or empty => equal
|
|
9876
9893
|
|
|
@@ -10005,9 +10022,7 @@ the query.
|
|
|
10005
10022
|
<Info>
|
|
10006
10023
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
10007
10024
|
|
|
10008
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
10009
|
-
|
|
10010
|
-
For example:
|
|
10025
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
10011
10026
|
|
|
10012
10027
|
--url https://api-sandbox.payabli.com/api/Query/devices/org/236?parameters=status=1&limitRecord=20
|
|
10013
10028
|
|
|
@@ -10020,7 +10035,7 @@ See [Filters and Conditions
|
|
|
10020
10035
|
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
|
|
10021
10036
|
for more information.
|
|
10022
10037
|
|
|
10023
|
-
**
|
|
10038
|
+
**Accepted field names:**
|
|
10024
10039
|
|
|
10025
10040
|
|
|
10026
10041
|
- `deviceId` (eq, ne, ct, nct)
|
|
@@ -10069,8 +10084,16 @@ for more information.
|
|
|
10069
10084
|
|
|
10070
10085
|
- `parentOrgName` (eq, ne, ct, nct)
|
|
10071
10086
|
|
|
10087
|
+
- `paypointLogo` (eq, ne, ct, nct)
|
|
10088
|
+
|
|
10089
|
+
- `parentOrgLogo` (eq, ne, ct, nct)
|
|
10072
10090
|
|
|
10073
|
-
|
|
10091
|
+
- `transactionCount` (eq, ne, gt, ge, lt, le)
|
|
10092
|
+
|
|
10093
|
+
- `volumeProcessed` (eq, ne, gt, ge, lt, le)
|
|
10094
|
+
|
|
10095
|
+
|
|
10096
|
+
**Accepted comparison operators:**
|
|
10074
10097
|
|
|
10075
10098
|
- `eq` or empty => equal
|
|
10076
10099
|
|
|
@@ -10195,9 +10218,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
10195
10218
|
<Info>
|
|
10196
10219
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
10197
10220
|
|
|
10198
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
10199
|
-
|
|
10200
|
-
For example:
|
|
10221
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
10201
10222
|
|
|
10202
10223
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
10203
10224
|
|
|
@@ -10208,11 +10229,11 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
10208
10229
|
|
|
10209
10230
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
10210
10231
|
|
|
10211
|
-
|
|
10232
|
+
**Accepted field names:**
|
|
10212
10233
|
- `reportName` (ct, nct, eq, ne)
|
|
10213
10234
|
- `createdAt` (gt, ge, lt, le, eq, ne)
|
|
10214
10235
|
|
|
10215
|
-
|
|
10236
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
10216
10237
|
- eq or empty => equal
|
|
10217
10238
|
- gt => greater than
|
|
10218
10239
|
- ge => greater or equal
|
|
@@ -10224,7 +10245,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
10224
10245
|
- in => inside array
|
|
10225
10246
|
- nin => not inside array
|
|
10226
10247
|
|
|
10227
|
-
|
|
10248
|
+
Accepted parameters:
|
|
10228
10249
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
10229
10250
|
- fromRecord : initial record in query
|
|
10230
10251
|
|
|
@@ -10332,9 +10353,7 @@ client.query.list_notification_reports_org(
|
|
|
10332
10353
|
Collection of field names, conditions, and values used to filter the query <Info>
|
|
10333
10354
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
10334
10355
|
|
|
10335
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
10336
|
-
|
|
10337
|
-
For example:
|
|
10356
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
10338
10357
|
|
|
10339
10358
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
10340
10359
|
|
|
@@ -10344,11 +10363,11 @@ Collection of field names, conditions, and values used to filter the query <Info
|
|
|
10344
10363
|
</Info>
|
|
10345
10364
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
10346
10365
|
|
|
10347
|
-
|
|
10366
|
+
**Accepted field names:**
|
|
10348
10367
|
- `reportName` (ct, nct, eq, ne)
|
|
10349
10368
|
- `createdAt` (gt, ge, lt, le, eq, ne)
|
|
10350
10369
|
|
|
10351
|
-
|
|
10370
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
10352
10371
|
- eq or empty => equal
|
|
10353
10372
|
- gt => greater than
|
|
10354
10373
|
- ge => greater or equal
|
|
@@ -10360,7 +10379,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
10360
10379
|
- in => inside array
|
|
10361
10380
|
- nin => not inside array
|
|
10362
10381
|
|
|
10363
|
-
|
|
10382
|
+
Accepted parameters:
|
|
10364
10383
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
10365
10384
|
- fromRecord : initial record in query
|
|
10366
10385
|
|
|
@@ -10469,9 +10488,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
10469
10488
|
<Info>
|
|
10470
10489
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
10471
10490
|
|
|
10472
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
10473
|
-
|
|
10474
|
-
For example:
|
|
10491
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
10475
10492
|
|
|
10476
10493
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
10477
10494
|
|
|
@@ -10481,14 +10498,14 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
10481
10498
|
</Info>
|
|
10482
10499
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
10483
10500
|
|
|
10484
|
-
|
|
10501
|
+
**Accepted field names:**
|
|
10485
10502
|
- `frequency` (in, nin,ne, eq)
|
|
10486
10503
|
- `method` (in, nin, eq, ne)
|
|
10487
10504
|
- `event` (in, nin, eq, ne)
|
|
10488
10505
|
- `target` (ct, nct, eq, ne)
|
|
10489
10506
|
- `status` (eq, ne)
|
|
10490
10507
|
|
|
10491
|
-
|
|
10508
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
10492
10509
|
- eq or empty => equal
|
|
10493
10510
|
- gt => greater than
|
|
10494
10511
|
- ge => greater or equal
|
|
@@ -10500,7 +10517,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
10500
10517
|
- in => inside array
|
|
10501
10518
|
- nin => not inside array
|
|
10502
10519
|
|
|
10503
|
-
|
|
10520
|
+
Accepted parameters:
|
|
10504
10521
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
10505
10522
|
- fromRecord : initial record in query
|
|
10506
10523
|
|
|
@@ -10609,9 +10626,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
10609
10626
|
<Info>
|
|
10610
10627
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
10611
10628
|
|
|
10612
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
10613
|
-
|
|
10614
|
-
For example:
|
|
10629
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
10615
10630
|
|
|
10616
10631
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
10617
10632
|
|
|
@@ -10621,14 +10636,14 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
10621
10636
|
</Info>
|
|
10622
10637
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
10623
10638
|
|
|
10624
|
-
|
|
10639
|
+
**Accepted field names:**
|
|
10625
10640
|
- `frequency` (in, nin,ne, eq)
|
|
10626
10641
|
- `method` (in, nin, eq, ne)
|
|
10627
10642
|
- `event` (in, nin, eq, ne)
|
|
10628
10643
|
- `target` (ct, nct, eq, ne)
|
|
10629
10644
|
- `status` (eq, ne)
|
|
10630
10645
|
|
|
10631
|
-
|
|
10646
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
10632
10647
|
- eq or empty => equal
|
|
10633
10648
|
- gt => greater than
|
|
10634
10649
|
- ge => greater or equal
|
|
@@ -10640,7 +10655,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
10640
10655
|
- in => inside array
|
|
10641
10656
|
- nin => not inside array
|
|
10642
10657
|
|
|
10643
|
-
|
|
10658
|
+
Accepted parameters:
|
|
10644
10659
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
10645
10660
|
- fromRecord : initial record in query
|
|
10646
10661
|
|
|
@@ -10757,9 +10772,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
10757
10772
|
<Info>
|
|
10758
10773
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
10759
10774
|
|
|
10760
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
10761
|
-
|
|
10762
|
-
For example:
|
|
10775
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
10763
10776
|
|
|
10764
10777
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
10765
10778
|
|
|
@@ -10767,7 +10780,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
10767
10780
|
|
|
10768
10781
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
10769
10782
|
</Info>
|
|
10770
|
-
**
|
|
10783
|
+
**Accepted field names:**
|
|
10771
10784
|
|
|
10772
10785
|
- `createdAt` (gt, ge, lt, le, eq, ne)
|
|
10773
10786
|
- `startDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -10786,7 +10799,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
10786
10799
|
- `boardingId` (eq, ne)
|
|
10787
10800
|
- `entryName` (ct, nct)
|
|
10788
10801
|
|
|
10789
|
-
**
|
|
10802
|
+
**Accepted comparison operators - enclosed between parentheses:**
|
|
10790
10803
|
|
|
10791
10804
|
- `eq` or empty => equal
|
|
10792
10805
|
- `gt` => greater than
|
|
@@ -10799,7 +10812,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
10799
10812
|
- `in` => inside array
|
|
10800
10813
|
- `nin` => not inside array
|
|
10801
10814
|
|
|
10802
|
-
**
|
|
10815
|
+
**Accepted parameters:**
|
|
10803
10816
|
|
|
10804
10817
|
- `limitRecord` : max number of records for query (default="20", "0" or negative value for all)
|
|
10805
10818
|
- `fromRecord` : initial record in query
|
|
@@ -10917,9 +10930,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
10917
10930
|
<Info>
|
|
10918
10931
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
10919
10932
|
|
|
10920
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
10921
|
-
|
|
10922
|
-
For example:
|
|
10933
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
10923
10934
|
|
|
10924
10935
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
10925
10936
|
|
|
@@ -10928,7 +10939,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
10928
10939
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
10929
10940
|
</Info>
|
|
10930
10941
|
|
|
10931
|
-
|
|
10942
|
+
Accepted field names:
|
|
10932
10943
|
|
|
10933
10944
|
- `status` (in, nin, eq, ne)
|
|
10934
10945
|
- `transactionDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -10971,7 +10982,7 @@ List of field names accepted:
|
|
|
10971
10982
|
- `AchTraceNumber` (eq, ne)
|
|
10972
10983
|
- `payoutProgram`(eq, ne) the options are `managed` or `odp`. For example, `payoutProgram(eq)=managed` returns all records with a `payoutProgram` equal to `managed`.
|
|
10973
10984
|
|
|
10974
|
-
|
|
10985
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
10975
10986
|
- eq or empty => equal
|
|
10976
10987
|
- gt => greater than
|
|
10977
10988
|
- ge => greater or equal
|
|
@@ -10983,7 +10994,7 @@ List of field names accepted:
|
|
|
10983
10994
|
- in => inside array separated by \"|\"
|
|
10984
10995
|
- nin => not inside array separated by \"|\"
|
|
10985
10996
|
|
|
10986
|
-
|
|
10997
|
+
Accepted parameters:
|
|
10987
10998
|
|
|
10988
10999
|
- limitRecord : max number of records for query (default=\"20\", \"0\" or negative value for all)
|
|
10989
11000
|
- fromRecord : initial record in query
|
|
@@ -11104,9 +11115,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
11104
11115
|
<Info>
|
|
11105
11116
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
11106
11117
|
|
|
11107
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
11108
|
-
|
|
11109
|
-
For example:
|
|
11118
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
11110
11119
|
|
|
11111
11120
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
11112
11121
|
|
|
@@ -11114,7 +11123,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
11114
11123
|
|
|
11115
11124
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
11116
11125
|
</Info>
|
|
11117
|
-
|
|
11126
|
+
Accepted field names:
|
|
11118
11127
|
|
|
11119
11128
|
- `status` (in, nin, eq, ne)
|
|
11120
11129
|
- `transactionDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -11157,7 +11166,7 @@ List of field names accepted:
|
|
|
11157
11166
|
- `AchTraceNumber` (eq, ne)
|
|
11158
11167
|
- `payoutProgram`(eq, ne) the options are `managed` or `odp`. For example, `payoutProgram(eq)=managed` returns all records with a `payoutProgram` equal to `managed`.
|
|
11159
11168
|
|
|
11160
|
-
|
|
11169
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
11161
11170
|
- eq or empty => equal
|
|
11162
11171
|
- gt => greater than
|
|
11163
11172
|
- ge => greater or equal
|
|
@@ -11169,7 +11178,7 @@ List of field names accepted:
|
|
|
11169
11178
|
- in => inside array separated by \"|\"
|
|
11170
11179
|
- nin => not inside array separated by \"|\"
|
|
11171
11180
|
|
|
11172
|
-
|
|
11181
|
+
Accepted parameters:
|
|
11173
11182
|
|
|
11174
11183
|
- limitRecord : max number of records for query (default=\"20\", \"0\" or negative value for all)
|
|
11175
11184
|
- fromRecord : initial record in query
|
|
@@ -11290,9 +11299,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
11290
11299
|
<Info>
|
|
11291
11300
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
11292
11301
|
|
|
11293
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
11294
|
-
|
|
11295
|
-
For example:
|
|
11302
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
11296
11303
|
|
|
11297
11304
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
11298
11305
|
|
|
@@ -11300,7 +11307,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
11300
11307
|
|
|
11301
11308
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
11302
11309
|
</Info>
|
|
11303
|
-
**
|
|
11310
|
+
**Accepted field names:**
|
|
11304
11311
|
|
|
11305
11312
|
- `createdAt` (gt, ge, lt, le, eq, ne)
|
|
11306
11313
|
- `lastModified` (gt, ge, lt, le, eq, ne)
|
|
@@ -11324,7 +11331,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
11324
11331
|
- `entryName` (ct, nct)
|
|
11325
11332
|
- `externalOrgID` (ct, nct)
|
|
11326
11333
|
|
|
11327
|
-
**
|
|
11334
|
+
**Accepted comparison operators - enclosed between parentheses:**
|
|
11328
11335
|
|
|
11329
11336
|
- `eq` or empty => equal
|
|
11330
11337
|
- `gt` => greater than
|
|
@@ -11337,7 +11344,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
11337
11344
|
- `in` => inside array
|
|
11338
11345
|
- `nin` => not inside array
|
|
11339
11346
|
|
|
11340
|
-
**
|
|
11347
|
+
**Accepted parameters:**
|
|
11341
11348
|
|
|
11342
11349
|
- `limitRecord` : max number of records for query (default="20", "0" or negative value for all)
|
|
11343
11350
|
- `fromRecord` : initial record in query
|
|
@@ -11455,9 +11462,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
11455
11462
|
<Info>
|
|
11456
11463
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
11457
11464
|
|
|
11458
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
11459
|
-
|
|
11460
|
-
For example:
|
|
11465
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
11461
11466
|
|
|
11462
11467
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
11463
11468
|
|
|
@@ -11468,7 +11473,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
11468
11473
|
|
|
11469
11474
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
11470
11475
|
|
|
11471
|
-
**
|
|
11476
|
+
**Accepted field names:**
|
|
11472
11477
|
|
|
11473
11478
|
- `settlementDate` (gt, ge, lt, le, eq, ne)
|
|
11474
11479
|
- `depositDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -11508,7 +11513,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
11508
11513
|
- `batchId` (ct, nct, eq, neq)
|
|
11509
11514
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
11510
11515
|
|
|
11511
|
-
**
|
|
11516
|
+
**Accepted comparison operators:**
|
|
11512
11517
|
- `eq` or empty => equal
|
|
11513
11518
|
- `gt` => greater than
|
|
11514
11519
|
- `ge` => greater or equal
|
|
@@ -11520,7 +11525,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
11520
11525
|
- `in` => inside array separated by "|"
|
|
11521
11526
|
- `nin` => not inside array separated by "|"
|
|
11522
11527
|
|
|
11523
|
-
**
|
|
11528
|
+
**Accepted parameters:**
|
|
11524
11529
|
|
|
11525
11530
|
- `limitRecord`: max number of records for query (default="20", "0" or negative value for all)
|
|
11526
11531
|
- `fromRecord`: initial record in query
|
|
@@ -11638,9 +11643,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
11638
11643
|
<Info>
|
|
11639
11644
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
11640
11645
|
|
|
11641
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
11642
|
-
|
|
11643
|
-
For example:
|
|
11646
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
11644
11647
|
|
|
11645
11648
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
11646
11649
|
|
|
@@ -11651,7 +11654,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
11651
11654
|
|
|
11652
11655
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
11653
11656
|
|
|
11654
|
-
**
|
|
11657
|
+
**Accepted field names:**
|
|
11655
11658
|
|
|
11656
11659
|
- `settlementDate` (gt, ge, lt, le, eq, ne)
|
|
11657
11660
|
- `depositDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -11691,7 +11694,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
11691
11694
|
- `batchId` (ct, nct, eq, neq)
|
|
11692
11695
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
11693
11696
|
|
|
11694
|
-
**
|
|
11697
|
+
**Accepted comparison operators:**
|
|
11695
11698
|
- `eq` or empty => equal
|
|
11696
11699
|
- `gt` => greater than
|
|
11697
11700
|
- `ge` => greater or equal
|
|
@@ -11703,7 +11706,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
11703
11706
|
- `in` => inside array separated by "|"
|
|
11704
11707
|
- `nin` => not inside array separated by "|"
|
|
11705
11708
|
|
|
11706
|
-
**
|
|
11709
|
+
**Accepted parameters:**
|
|
11707
11710
|
|
|
11708
11711
|
- `limitRecord`: max number of records for query (default="20", "0" or negative value for all)
|
|
11709
11712
|
- `fromRecord`: initial record in query
|
|
@@ -11821,9 +11824,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
11821
11824
|
<Info>
|
|
11822
11825
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
11823
11826
|
|
|
11824
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
11825
|
-
|
|
11826
|
-
For example:
|
|
11827
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
11827
11828
|
|
|
11828
11829
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
11829
11830
|
|
|
@@ -11833,7 +11834,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
11833
11834
|
</Info>
|
|
11834
11835
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
11835
11836
|
|
|
11836
|
-
**
|
|
11837
|
+
**Accepted field names:**
|
|
11837
11838
|
|
|
11838
11839
|
- `startDate` (gt, ge, lt, le, eq, ne)
|
|
11839
11840
|
- `endDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -11883,7 +11884,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
11883
11884
|
- `invoiceNumber` (ct, nct)
|
|
11884
11885
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
11885
11886
|
|
|
11886
|
-
**
|
|
11887
|
+
**Accepted comparison operators:**
|
|
11887
11888
|
- `eq` or empty => equal
|
|
11888
11889
|
- `gt` => greater than
|
|
11889
11890
|
- `ge` => greater or equal
|
|
@@ -12006,9 +12007,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
12006
12007
|
<Info>
|
|
12007
12008
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
12008
12009
|
|
|
12009
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
12010
|
-
|
|
12011
|
-
For example:
|
|
12010
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
12012
12011
|
|
|
12013
12012
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
12014
12013
|
|
|
@@ -12018,7 +12017,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
12018
12017
|
</Info>
|
|
12019
12018
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
12020
12019
|
|
|
12021
|
-
**
|
|
12020
|
+
**Accepted field names:**
|
|
12022
12021
|
|
|
12023
12022
|
- `startDate` (gt, ge, lt, le, eq, ne)
|
|
12024
12023
|
- `endDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -12068,7 +12067,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
12068
12067
|
- `invoiceNumber` (ct, nct)
|
|
12069
12068
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
12070
12069
|
|
|
12071
|
-
**
|
|
12070
|
+
**Accepted comparison operators:**
|
|
12072
12071
|
- `eq` or empty => equal
|
|
12073
12072
|
- `gt` => greater than
|
|
12074
12073
|
- `ge` => greater or equal
|
|
@@ -12191,9 +12190,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
12191
12190
|
<Info>
|
|
12192
12191
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
12193
12192
|
|
|
12194
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
12195
|
-
|
|
12196
|
-
For example:
|
|
12193
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
12197
12194
|
|
|
12198
12195
|
--url https://api-sandbox.payabli.com/api/Query/payoutsubscriptions/entry123?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
12199
12196
|
|
|
@@ -12202,7 +12199,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
12202
12199
|
--url https://api-sandbox.payabli.com/api/Query/payoutsubscriptions/entry123?totalAmount(gt)=1000&limitRecord=20
|
|
12203
12200
|
</Info>
|
|
12204
12201
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
12205
|
-
**
|
|
12202
|
+
**Accepted field names:**
|
|
12206
12203
|
|
|
12207
12204
|
- `startDate` (gt, ge, lt, le, eq, ne)
|
|
12208
12205
|
- `endDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -12239,7 +12236,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
12239
12236
|
- `country` (ne, eq, ct, nct)
|
|
12240
12237
|
- `zip` (ne, eq, ct, nct)
|
|
12241
12238
|
|
|
12242
|
-
**
|
|
12239
|
+
**Accepted comparison operators:**
|
|
12243
12240
|
- `eq` or empty => equal
|
|
12244
12241
|
- `gt` => greater than
|
|
12245
12242
|
- `ge` => greater or equal
|
|
@@ -12362,9 +12359,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
12362
12359
|
<Info>
|
|
12363
12360
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
12364
12361
|
|
|
12365
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
12366
|
-
|
|
12367
|
-
For example:
|
|
12362
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
12368
12363
|
|
|
12369
12364
|
--url https://api-sandbox.payabli.com/api/Query/payoutsubscriptions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
12370
12365
|
|
|
@@ -12373,7 +12368,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
12373
12368
|
--url https://api-sandbox.payabli.com/api/Query/payoutsubscriptions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
12374
12369
|
</Info>
|
|
12375
12370
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
12376
|
-
**
|
|
12371
|
+
**Accepted field names:**
|
|
12377
12372
|
|
|
12378
12373
|
- `startDate` (gt, ge, lt, le, eq, ne)
|
|
12379
12374
|
- `endDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -12410,7 +12405,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
12410
12405
|
- `country` (ne, eq, ct, nct)
|
|
12411
12406
|
- `zip` (ne, eq, ct, nct)
|
|
12412
12407
|
|
|
12413
|
-
**
|
|
12408
|
+
**Accepted comparison operators:**
|
|
12414
12409
|
- `eq` or empty => equal
|
|
12415
12410
|
- `gt` => greater than
|
|
12416
12411
|
- `ge` => greater or equal
|
|
@@ -12542,9 +12537,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
12542
12537
|
<Info>
|
|
12543
12538
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
12544
12539
|
|
|
12545
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
12546
|
-
|
|
12547
|
-
For example:
|
|
12540
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
12548
12541
|
|
|
12549
12542
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
12550
12543
|
|
|
@@ -12554,7 +12547,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
12554
12547
|
</Info>
|
|
12555
12548
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
12556
12549
|
|
|
12557
|
-
**
|
|
12550
|
+
**Accepted field names:**
|
|
12558
12551
|
|
|
12559
12552
|
- `transactionDate` (gt, ge, lt, le, eq, ne)
|
|
12560
12553
|
- `transId` (ne, eq, ct, nct, in, nin)
|
|
@@ -12612,7 +12605,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
12612
12605
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name related to customer data
|
|
12613
12606
|
- 'invoiceAdditional-xxx' (ne, eq, ct, nct) where xxx is the additional field name related to invoice data
|
|
12614
12607
|
|
|
12615
|
-
**
|
|
12608
|
+
**Accepted comparison operators:**
|
|
12616
12609
|
- `eq` or empty => equal
|
|
12617
12610
|
- `gt` => greater than
|
|
12618
12611
|
- `ge` => greater or equal
|
|
@@ -12744,9 +12737,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
12744
12737
|
<Info>
|
|
12745
12738
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
12746
12739
|
|
|
12747
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
12748
|
-
|
|
12749
|
-
For example:
|
|
12740
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
12750
12741
|
|
|
12751
12742
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
12752
12743
|
|
|
@@ -12756,7 +12747,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
12756
12747
|
</Info>
|
|
12757
12748
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
12758
12749
|
|
|
12759
|
-
**
|
|
12750
|
+
**Accepted field names:**
|
|
12760
12751
|
|
|
12761
12752
|
- `transactionDate` (gt, ge, lt, le, eq, ne)
|
|
12762
12753
|
- `transId` (ne, eq, ct, nct, in, nin)
|
|
@@ -12813,7 +12804,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
12813
12804
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name related to customer data
|
|
12814
12805
|
- 'invoiceAdditional-xxx' (ne, eq, ct, nct) where xxx is the additional field name related to invoice data
|
|
12815
12806
|
|
|
12816
|
-
**
|
|
12807
|
+
**Accepted comparison operators:**
|
|
12817
12808
|
- `eq` or empty => equal
|
|
12818
12809
|
- `gt` => greater than
|
|
12819
12810
|
- `ge` => greater or equal
|
|
@@ -12944,9 +12935,7 @@ the query.
|
|
|
12944
12935
|
<Info>
|
|
12945
12936
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
12946
12937
|
|
|
12947
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
12948
|
-
|
|
12949
|
-
For example:
|
|
12938
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
12950
12939
|
|
|
12951
12940
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
12952
12941
|
|
|
@@ -12960,7 +12949,7 @@ Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filter
|
|
|
12960
12949
|
for more information.
|
|
12961
12950
|
|
|
12962
12951
|
|
|
12963
|
-
**
|
|
12952
|
+
**Accepted field names:**
|
|
12964
12953
|
|
|
12965
12954
|
- `grossAmount` (gt, ge, lt, le, eq, ne)
|
|
12966
12955
|
- `chargeBackAmount` (gt, ge, lt, le, eq, ne)
|
|
@@ -13096,7 +13085,7 @@ Collection of field names, conditions, and values used to filter the query. See
|
|
|
13096
13085
|
|
|
13097
13086
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
13098
13087
|
</Info>
|
|
13099
|
-
|
|
13088
|
+
Accepted field names:
|
|
13100
13089
|
|
|
13101
13090
|
- `transferDate` (gt, ge, lt, le, eq, ne)
|
|
13102
13091
|
- `grossAmount` (gt, ge, lt, le, eq, ne)
|
|
@@ -13238,7 +13227,7 @@ Collection of field names, conditions, and values used to filter the query. See
|
|
|
13238
13227
|
|
|
13239
13228
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
13240
13229
|
</Info>
|
|
13241
|
-
|
|
13230
|
+
Accepted field names:
|
|
13242
13231
|
|
|
13243
13232
|
- `transferDate` (gt, ge, lt, le, eq, ne)
|
|
13244
13233
|
- `grossAmount` (gt, ge, lt, le, eq, ne)
|
|
@@ -13369,7 +13358,7 @@ Collection of field names, conditions, and values used to filter the query. See
|
|
|
13369
13358
|
|
|
13370
13359
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
13371
13360
|
</Info>
|
|
13372
|
-
|
|
13361
|
+
Accepted field names:
|
|
13373
13362
|
|
|
13374
13363
|
- `transferDate` (gt, ge, lt, le, eq, ne)
|
|
13375
13364
|
- `grossAmount` (gt, ge, lt, le, eq, ne)
|
|
@@ -13498,7 +13487,7 @@ Collection of field names, conditions, and values used to filter the query. See
|
|
|
13498
13487
|
|
|
13499
13488
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
13500
13489
|
</Info>
|
|
13501
|
-
|
|
13490
|
+
Accepted field names:
|
|
13502
13491
|
|
|
13503
13492
|
- `transferDate` (gt, ge, lt, le, eq, ne)
|
|
13504
13493
|
- `grossAmount` (gt, ge, lt, le, eq, ne)
|
|
@@ -13636,7 +13625,7 @@ Collection of field names, conditions, and values used to filter the query. See
|
|
|
13636
13625
|
|
|
13637
13626
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
13638
13627
|
</Info>
|
|
13639
|
-
|
|
13628
|
+
Accepted field names:
|
|
13640
13629
|
|
|
13641
13630
|
- `grossAmount` (gt, ge, lt, le, eq, ne)
|
|
13642
13631
|
- `returnedAmount` (gt, ge, lt, le, eq, ne)
|
|
@@ -13753,9 +13742,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
13753
13742
|
<Info>
|
|
13754
13743
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
13755
13744
|
|
|
13756
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
13757
|
-
|
|
13758
|
-
For example:
|
|
13745
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
13759
13746
|
|
|
13760
13747
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
13761
13748
|
|
|
@@ -13765,7 +13752,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
13765
13752
|
</Info>
|
|
13766
13753
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
13767
13754
|
|
|
13768
|
-
**
|
|
13755
|
+
**Accepted field names:**
|
|
13769
13756
|
|
|
13770
13757
|
- `createdDate` (gt, ge, lt, le, eq, ne)
|
|
13771
13758
|
- `name` (ne, eq, ct, nct)
|
|
@@ -13773,7 +13760,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
13773
13760
|
- `status` (in, nin, eq, ne)
|
|
13774
13761
|
- `role.xxx` (ne, eq, ct, nct) where xxx is the role field: `roleLabel` or `roleValue`
|
|
13775
13762
|
|
|
13776
|
-
**
|
|
13763
|
+
**Accepted comparison operators - enclosed between parentheses:**
|
|
13777
13764
|
|
|
13778
13765
|
- `eq` or empty => equal
|
|
13779
13766
|
- `gt` => greater than
|
|
@@ -13786,7 +13773,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
13786
13773
|
- `in` => inside array separated by "|"
|
|
13787
13774
|
- `nin` => not inside array separated by "|"
|
|
13788
13775
|
|
|
13789
|
-
**
|
|
13776
|
+
**Accepted parameters:**
|
|
13790
13777
|
- `limitRecord`: max number of records for query (default="20", "0" or negative value for all)
|
|
13791
13778
|
- `fromRecord`: initial record in query
|
|
13792
13779
|
|
|
@@ -13895,9 +13882,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
13895
13882
|
<Info>
|
|
13896
13883
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
13897
13884
|
|
|
13898
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
13899
|
-
|
|
13900
|
-
For example:
|
|
13885
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
13901
13886
|
|
|
13902
13887
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
13903
13888
|
|
|
@@ -13907,7 +13892,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
13907
13892
|
</Info>
|
|
13908
13893
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
13909
13894
|
|
|
13910
|
-
**
|
|
13895
|
+
**Accepted field names:**
|
|
13911
13896
|
|
|
13912
13897
|
- `createdDate` (gt, ge, lt, le, eq, ne)
|
|
13913
13898
|
- `name` (ne, eq, ct, nct)
|
|
@@ -13915,7 +13900,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
13915
13900
|
- `status` (in, nin, eq, ne)
|
|
13916
13901
|
- `role.xxx` (ne, eq, ct, nct) where xxx is the role field: `roleLabel` or `roleValue`
|
|
13917
13902
|
|
|
13918
|
-
**
|
|
13903
|
+
**Accepted comparison operators - enclosed between parentheses:**
|
|
13919
13904
|
|
|
13920
13905
|
- `eq` or empty => equal
|
|
13921
13906
|
- `gt` => greater than
|
|
@@ -13928,7 +13913,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
13928
13913
|
- `in` => inside array separated by "|"
|
|
13929
13914
|
- `nin` => not inside array separated by "|"
|
|
13930
13915
|
|
|
13931
|
-
**
|
|
13916
|
+
**Accepted parameters:**
|
|
13932
13917
|
- `limitRecord`: max number of records for query (default="20", "0" or negative value for all)
|
|
13933
13918
|
- `fromRecord`: initial record in query
|
|
13934
13919
|
|
|
@@ -14045,9 +14030,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
14045
14030
|
<Info>
|
|
14046
14031
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
14047
14032
|
|
|
14048
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
14049
|
-
|
|
14050
|
-
For example:
|
|
14033
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
14051
14034
|
|
|
14052
14035
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
14053
14036
|
|
|
@@ -14057,7 +14040,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
14057
14040
|
</Info>
|
|
14058
14041
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
14059
14042
|
|
|
14060
|
-
|
|
14043
|
+
**Accepted field names:**
|
|
14061
14044
|
- `method` (in, nin, eq, ne)
|
|
14062
14045
|
- `enrollmentStatus` (in,nin, eq, ne)
|
|
14063
14046
|
- `status` (in, nin, eq, ne)
|
|
@@ -14079,7 +14062,7 @@ List of field names accepted:
|
|
|
14079
14062
|
- `paypointDba` (ne, eq, ct, nct)
|
|
14080
14063
|
- `orgName` (ne, eq, ct, nct)
|
|
14081
14064
|
|
|
14082
|
-
|
|
14065
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
14083
14066
|
- eq or empty => equal
|
|
14084
14067
|
- gt => greater than
|
|
14085
14068
|
- ge => greater or equal
|
|
@@ -14091,7 +14074,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
14091
14074
|
- in => inside array separated by "|"
|
|
14092
14075
|
- nin => not inside array separated by "|"
|
|
14093
14076
|
|
|
14094
|
-
|
|
14077
|
+
Accepted parameters:
|
|
14095
14078
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
14096
14079
|
- fromRecord : initial record in query
|
|
14097
14080
|
|
|
@@ -14208,9 +14191,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
14208
14191
|
<Info>
|
|
14209
14192
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
14210
14193
|
|
|
14211
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
14212
|
-
|
|
14213
|
-
For example:
|
|
14194
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
14214
14195
|
|
|
14215
14196
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
14216
14197
|
|
|
@@ -14220,7 +14201,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
14220
14201
|
</Info>
|
|
14221
14202
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
14222
14203
|
|
|
14223
|
-
|
|
14204
|
+
**Accepted field names:**
|
|
14224
14205
|
- `method` (in, nin, eq, ne)
|
|
14225
14206
|
- `enrollmentStatus` (in,nin, eq, ne)
|
|
14226
14207
|
- `status` (in, nin, eq, ne)
|
|
@@ -14242,7 +14223,7 @@ List of field names accepted:
|
|
|
14242
14223
|
- `parentOrgId` (ne, eq, nin, in)
|
|
14243
14224
|
- `orgName` (ne, eq, ct, nct)
|
|
14244
14225
|
|
|
14245
|
-
|
|
14226
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
14246
14227
|
- eq or empty => equal
|
|
14247
14228
|
- gt => greater than
|
|
14248
14229
|
- ge => greater or equal
|
|
@@ -14254,7 +14235,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
14254
14235
|
- in => inside array separated by "|"
|
|
14255
14236
|
- nin => not inside array separated by "|"
|
|
14256
14237
|
|
|
14257
|
-
|
|
14238
|
+
Accepted parameters:
|
|
14258
14239
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
14259
14240
|
- fromRecord : initial record in query
|
|
14260
14241
|
|
|
@@ -14371,9 +14352,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
14371
14352
|
<Info>
|
|
14372
14353
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
14373
14354
|
|
|
14374
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
14375
|
-
|
|
14376
|
-
For example:
|
|
14355
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
14377
14356
|
|
|
14378
14357
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
14379
14358
|
|
|
@@ -14381,7 +14360,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
14381
14360
|
|
|
14382
14361
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
14383
14362
|
</Info>
|
|
14384
|
-
|
|
14363
|
+
Accepted field names:
|
|
14385
14364
|
|
|
14386
14365
|
- `status` (eq, ne, ct, nct, sw, ew)
|
|
14387
14366
|
- `createdAt` (gt, ge, lt, le, eq, ne)
|
|
@@ -14402,7 +14381,7 @@ List of field names accepted:
|
|
|
14402
14381
|
- `paypointId` (eq, ne, gt, ge, lt, le)
|
|
14403
14382
|
- `cardType` (eq, ne, gt, ge, lt, le)
|
|
14404
14383
|
|
|
14405
|
-
|
|
14384
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
14406
14385
|
|
|
14407
14386
|
- eq or empty => equal
|
|
14408
14387
|
- gt => greater than
|
|
@@ -14521,9 +14500,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
14521
14500
|
<Info>
|
|
14522
14501
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
14523
14502
|
|
|
14524
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
14525
|
-
|
|
14526
|
-
For example:
|
|
14503
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
14527
14504
|
|
|
14528
14505
|
--url https://api-sandbox.payabli.com/api/Query/vcardsTransactions/8cfec329267?parameters=transactionAmount(gt)=100&limitRecord=20
|
|
14529
14506
|
|
|
@@ -14532,7 +14509,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
14532
14509
|
--url https://api-sandbox.payabli.com/api/Query/vcardsTransactions/8cfec329267?transactionAmount(gt)=100&limitRecord=20
|
|
14533
14510
|
</Info>
|
|
14534
14511
|
|
|
14535
|
-
|
|
14512
|
+
Accepted field names:
|
|
14536
14513
|
|
|
14537
14514
|
- `identifier` (eq, ne, ct, nct)
|
|
14538
14515
|
- `transactionType` (eq, ne, ct, nct)
|
|
@@ -14557,7 +14534,7 @@ List of field names accepted:
|
|
|
14557
14534
|
- `externalPaypointID` (ct, nct, eq, ne)
|
|
14558
14535
|
- `paypointId` (gt, lt, eq, ne)
|
|
14559
14536
|
|
|
14560
|
-
|
|
14537
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
14561
14538
|
|
|
14562
14539
|
- eq or empty => equal
|
|
14563
14540
|
- gt => greater than
|
|
@@ -14674,9 +14651,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
14674
14651
|
<Info>
|
|
14675
14652
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
14676
14653
|
|
|
14677
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
14678
|
-
|
|
14679
|
-
For example:
|
|
14654
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
14680
14655
|
|
|
14681
14656
|
--url https://api-sandbox.payabli.com/api/Query/vcardsTransactions/org/236?parameters=transactionAmount(gt)=100&limitRecord=20
|
|
14682
14657
|
|
|
@@ -14685,7 +14660,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
14685
14660
|
--url https://api-sandbox.payabli.com/api/Query/vcardsTransactions/org/236?transactionAmount(gt)=100&limitRecord=20
|
|
14686
14661
|
</Info>
|
|
14687
14662
|
|
|
14688
|
-
|
|
14663
|
+
Accepted field names:
|
|
14689
14664
|
|
|
14690
14665
|
- `identifier` (eq, ne, ct, nct)
|
|
14691
14666
|
- `transactionType` (eq, ne, ct, nct)
|
|
@@ -14710,7 +14685,7 @@ List of field names accepted:
|
|
|
14710
14685
|
- `externalPaypointID` (ct, nct, eq, ne)
|
|
14711
14686
|
- `paypointId` (gt, lt, eq, ne)
|
|
14712
14687
|
|
|
14713
|
-
|
|
14688
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
14714
14689
|
|
|
14715
14690
|
- eq or empty => equal
|
|
14716
14691
|
- gt => greater than
|
|
@@ -14834,9 +14809,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
14834
14809
|
<Info>
|
|
14835
14810
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
14836
14811
|
|
|
14837
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
14838
|
-
|
|
14839
|
-
For example:
|
|
14812
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
14840
14813
|
|
|
14841
14814
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
14842
14815
|
|
|
@@ -14844,7 +14817,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
14844
14817
|
|
|
14845
14818
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
14846
14819
|
</Info>
|
|
14847
|
-
|
|
14820
|
+
Accepted field names:
|
|
14848
14821
|
|
|
14849
14822
|
- `status` (eq, ne, ct, nct, sw, ew)
|
|
14850
14823
|
- `createdAt` (gt, ge, lt, le, eq, ne)
|
|
@@ -14865,7 +14838,7 @@ List of field names accepted:
|
|
|
14865
14838
|
- `paypointId` (eq, ne, gt, ge, lt, le)
|
|
14866
14839
|
- `cardType` (eq, ne, gt, ge, lt, le)
|
|
14867
14840
|
|
|
14868
|
-
|
|
14841
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
14869
14842
|
|
|
14870
14843
|
- eq or empty => equal
|
|
14871
14844
|
- gt => greater than
|
|
@@ -16048,9 +16021,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
16048
16021
|
<Info>
|
|
16049
16022
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
16050
16023
|
|
|
16051
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
16052
|
-
|
|
16053
|
-
For example:
|
|
16024
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
16054
16025
|
|
|
16055
16026
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
16056
16027
|
|
|
@@ -16061,7 +16032,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
16061
16032
|
</Info>
|
|
16062
16033
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
16063
16034
|
|
|
16064
|
-
|
|
16035
|
+
**Accepted field names:**
|
|
16065
16036
|
|
|
16066
16037
|
- `categories` (ct, nct)
|
|
16067
16038
|
- `code` (ne, eq, ct, nct)
|
|
@@ -16080,7 +16051,7 @@ List of field names accepted:
|
|
|
16080
16051
|
- `updatedDate` (gt, ge, lt, le, eq, ne)
|
|
16081
16052
|
- `value` (gt, ge, lt, le, eq, ne)
|
|
16082
16053
|
|
|
16083
|
-
|
|
16054
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
16084
16055
|
|
|
16085
16056
|
- eq or empty => equal
|
|
16086
16057
|
- gt => greater than
|
|
@@ -16093,7 +16064,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
16093
16064
|
- in => inside array separated by "|"
|
|
16094
16065
|
- nin => not inside array separated by "|"
|
|
16095
16066
|
|
|
16096
|
-
|
|
16067
|
+
Accepted parameters:
|
|
16097
16068
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
16098
16069
|
- fromRecord : initial record in query
|
|
16099
16070
|
|
|
@@ -16937,7 +16908,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
16937
16908
|
|
|
16938
16909
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
16939
16910
|
|
|
16940
|
-
|
|
16911
|
+
Accepted field names:
|
|
16941
16912
|
- `createdAt` (gt, ge, lt, le, eq, ne)
|
|
16942
16913
|
- `startDate` (gt, ge, lt, le, eq, ne)
|
|
16943
16914
|
- `dbaname` (ct, nct)
|
|
@@ -16957,7 +16928,7 @@ List of field names accepted:
|
|
|
16957
16928
|
- `repCode` (ct, nct, eq, ne)
|
|
16958
16929
|
- `repName` (ct, nct, eq, ne)
|
|
16959
16930
|
- `repOffice` (ct, nct, eq, ne)
|
|
16960
|
-
|
|
16931
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
16961
16932
|
- eq or empty => equal
|
|
16962
16933
|
- gt => greater than
|
|
16963
16934
|
- ge => greater or equal
|
|
@@ -17072,7 +17043,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
17072
17043
|
|
|
17073
17044
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
17074
17045
|
|
|
17075
|
-
|
|
17046
|
+
Accepted field names:
|
|
17076
17047
|
- `lastUpdated` (gt, ge, lt, le, eq, ne)
|
|
17077
17048
|
- `templateName` (ct, nct)
|
|
17078
17049
|
- `referenceName` (ct, nct)
|
|
@@ -17082,7 +17053,7 @@ List of field names accepted:
|
|
|
17082
17053
|
- `templateId` (eq, ne)
|
|
17083
17054
|
- `orgParentname` (ct, nct)
|
|
17084
17055
|
|
|
17085
|
-
|
|
17056
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
17086
17057
|
- eq or empty => equal
|
|
17087
17058
|
- gt => greater than
|
|
17088
17059
|
- ge => greater or equal
|
|
@@ -17094,7 +17065,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
17094
17065
|
- in => inside array
|
|
17095
17066
|
- nin => not inside array
|
|
17096
17067
|
|
|
17097
|
-
|
|
17068
|
+
Accepted parameters:
|
|
17098
17069
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
17099
17070
|
- fromRecord : initial record in query
|
|
17100
17071
|
|
|
@@ -17564,9 +17535,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
17564
17535
|
<Info>
|
|
17565
17536
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
17566
17537
|
|
|
17567
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
17568
|
-
|
|
17569
|
-
For example:
|
|
17538
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
17570
17539
|
|
|
17571
17540
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
17572
17541
|
|
|
@@ -17578,14 +17547,14 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
17578
17547
|
|
|
17579
17548
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
17580
17549
|
|
|
17581
|
-
|
|
17550
|
+
**Accepted field names:**
|
|
17582
17551
|
- `createdAt` (gt, ge, lt, le, eq, ne)
|
|
17583
17552
|
- `title` (ct, nct)
|
|
17584
17553
|
- `description` (ct, nct)
|
|
17585
17554
|
- `code` (ct, nct)
|
|
17586
17555
|
- `orgParentname` (ct, nct)
|
|
17587
17556
|
|
|
17588
|
-
|
|
17557
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
17589
17558
|
- eq or empty => equal
|
|
17590
17559
|
- gt => greater than
|
|
17591
17560
|
- ge => greater or equal
|
|
@@ -17597,7 +17566,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
17597
17566
|
- in => inside array
|
|
17598
17567
|
- nin => not inside array
|
|
17599
17568
|
|
|
17600
|
-
|
|
17569
|
+
Accepted parameters:
|
|
17601
17570
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
17602
17571
|
- fromRecord : initial record in query
|
|
17603
17572
|
|
|
@@ -17729,9 +17698,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
17729
17698
|
<Info>
|
|
17730
17699
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
17731
17700
|
|
|
17732
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
17733
|
-
|
|
17734
|
-
For example:
|
|
17701
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
17735
17702
|
|
|
17736
17703
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
17737
17704
|
|
|
@@ -17742,7 +17709,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
17742
17709
|
|
|
17743
17710
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
17744
17711
|
|
|
17745
|
-
|
|
17712
|
+
**Accepted field names:**
|
|
17746
17713
|
- `createdAt` (gt, ge, lt, le, eq, ne)
|
|
17747
17714
|
- `startDate` (gt, ge, lt, le, eq, ne)
|
|
17748
17715
|
- `dbaname` (ct, nct)
|
|
@@ -17759,7 +17726,7 @@ List of field names accepted:
|
|
|
17759
17726
|
- `status` (eq, ne)
|
|
17760
17727
|
- `orgParentname` (ct, nct)
|
|
17761
17728
|
|
|
17762
|
-
|
|
17729
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
17763
17730
|
- eq or empty => equal
|
|
17764
17731
|
- gt => greater than
|
|
17765
17732
|
- ge => greater or equal
|
|
@@ -17771,7 +17738,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
17771
17738
|
- in => inside array
|
|
17772
17739
|
- nin => not inside array
|
|
17773
17740
|
|
|
17774
|
-
|
|
17741
|
+
Accepted parameters:
|
|
17775
17742
|
- `limitRecord` : max number of records for query (default="20", "0" or negative value for all)
|
|
17776
17743
|
- `fromRecord` : initial record in query
|
|
17777
17744
|
|
|
@@ -17894,9 +17861,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
17894
17861
|
<Info>
|
|
17895
17862
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
17896
17863
|
|
|
17897
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
17898
|
-
|
|
17899
|
-
For example:
|
|
17864
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
17900
17865
|
|
|
17901
17866
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
17902
17867
|
|
|
@@ -17907,7 +17872,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
17907
17872
|
|
|
17908
17873
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
17909
17874
|
|
|
17910
|
-
**
|
|
17875
|
+
**Accepted field names:**
|
|
17911
17876
|
|
|
17912
17877
|
- `settlementDate` (gt, ge, lt, le, eq, ne)
|
|
17913
17878
|
- `depositDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -17947,7 +17912,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
17947
17912
|
- `batchId` (ct, nct, eq, neq)
|
|
17948
17913
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
17949
17914
|
|
|
17950
|
-
|
|
17915
|
+
Accepted parameters:
|
|
17951
17916
|
- limitRecord: max number of records for query (default="20", "0" or negative value for all)
|
|
17952
17917
|
- fromRecord: initial record in query
|
|
17953
17918
|
|
|
@@ -18070,9 +18035,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
18070
18035
|
<Info>
|
|
18071
18036
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
18072
18037
|
|
|
18073
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
18074
|
-
|
|
18075
|
-
For example:
|
|
18038
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
18076
18039
|
|
|
18077
18040
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
18078
18041
|
|
|
@@ -18083,7 +18046,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
18083
18046
|
|
|
18084
18047
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
18085
18048
|
|
|
18086
|
-
**
|
|
18049
|
+
**Accepted field names:**
|
|
18087
18050
|
|
|
18088
18051
|
- `settlementDate` (gt, ge, lt, le, eq, ne)
|
|
18089
18052
|
- `depositDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -18123,7 +18086,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
18123
18086
|
- `batchId` (ct, nct, eq, neq)
|
|
18124
18087
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
18125
18088
|
|
|
18126
|
-
|
|
18089
|
+
Accepted parameters:
|
|
18127
18090
|
- limitRecord: max number of records for query (default="20", "0" or negative value for all)
|
|
18128
18091
|
- fromRecord: initial record in query
|
|
18129
18092
|
|
|
@@ -18246,9 +18209,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
18246
18209
|
<Info>
|
|
18247
18210
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
18248
18211
|
|
|
18249
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
18250
|
-
|
|
18251
|
-
For example:
|
|
18212
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
18252
18213
|
|
|
18253
18214
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
18254
18215
|
|
|
@@ -18259,7 +18220,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
18259
18220
|
|
|
18260
18221
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
18261
18222
|
|
|
18262
|
-
|
|
18223
|
+
**Accepted field names:**
|
|
18263
18224
|
- `batchDate` (gt, ge, lt, le, eq, ne)
|
|
18264
18225
|
- `batchNumber` (ne, eq)
|
|
18265
18226
|
- `connectorName` (ne, eq, ct, nct)
|
|
@@ -18289,7 +18250,7 @@ List of field names accepted:
|
|
|
18289
18250
|
- `processor` (ne, eq, ct, nct)
|
|
18290
18251
|
- `transferStatus` (ne, eq, in, nin)
|
|
18291
18252
|
|
|
18292
|
-
|
|
18253
|
+
Accepted parameters:
|
|
18293
18254
|
- limitRecord: max number of records for query (default="20", "0" or negative value for all)
|
|
18294
18255
|
- fromRecord: initial record in query
|
|
18295
18256
|
|
|
@@ -18412,9 +18373,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
18412
18373
|
<Info>
|
|
18413
18374
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
18414
18375
|
|
|
18415
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
18416
|
-
|
|
18417
|
-
For example:
|
|
18376
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
18418
18377
|
|
|
18419
18378
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
18420
18379
|
|
|
@@ -18424,7 +18383,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
18424
18383
|
</Info>
|
|
18425
18384
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
18426
18385
|
|
|
18427
|
-
|
|
18386
|
+
**Accepted field names:**
|
|
18428
18387
|
- `batchDate` (gt, ge, lt, le, eq, ne)
|
|
18429
18388
|
- `batchNumber` (ne, eq)
|
|
18430
18389
|
- `connectorName` (ne, eq, ct, nct)
|
|
@@ -18454,7 +18413,7 @@ List of field names accepted:
|
|
|
18454
18413
|
- `processor` (ne, eq, ct, nct)
|
|
18455
18414
|
- `transferStatus` (ne, eq, in, nin)
|
|
18456
18415
|
|
|
18457
|
-
|
|
18416
|
+
Accepted parameters:
|
|
18458
18417
|
- `limitRecord`: max number of records for query (default="20", "0" or negative value for all)
|
|
18459
18418
|
- `fromRecord`: initial record in query
|
|
18460
18419
|
Example: `batchAmount(gt)=20` returns all records with a `batchAmount` greater than 20.00
|
|
@@ -18576,9 +18535,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
18576
18535
|
<Info>
|
|
18577
18536
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
18578
18537
|
|
|
18579
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
18580
|
-
|
|
18581
|
-
For example:
|
|
18538
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
18582
18539
|
|
|
18583
18540
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
18584
18541
|
|
|
@@ -18589,7 +18546,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
18589
18546
|
|
|
18590
18547
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
18591
18548
|
|
|
18592
|
-
|
|
18549
|
+
**Accepted field names:**
|
|
18593
18550
|
- `batchDate` (gt, ge, lt, le, eq, ne)
|
|
18594
18551
|
- `batchNumber` (ne, eq)
|
|
18595
18552
|
- `batchAmount` (gt, ge, lt, le, eq, ne)
|
|
@@ -18599,7 +18556,7 @@ List of field names accepted:
|
|
|
18599
18556
|
- `orgName` (ne, eq, ct, nct, nin, in)
|
|
18600
18557
|
- `paypointId` (ne, eq)
|
|
18601
18558
|
- `externalPaypointID` (ct, nct, eq, ne)
|
|
18602
|
-
|
|
18559
|
+
Accepted parameters:
|
|
18603
18560
|
- limitRecord: max number of records for query (default="20", "0" or negative value for all)
|
|
18604
18561
|
- fromRecord: initial record in query
|
|
18605
18562
|
|
|
@@ -18722,9 +18679,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
18722
18679
|
<Info>
|
|
18723
18680
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
18724
18681
|
|
|
18725
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
18726
|
-
|
|
18727
|
-
For example:
|
|
18682
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
18728
18683
|
|
|
18729
18684
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
18730
18685
|
|
|
@@ -18735,7 +18690,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
18735
18690
|
|
|
18736
18691
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
18737
18692
|
|
|
18738
|
-
|
|
18693
|
+
**Accepted field names:**
|
|
18739
18694
|
- `batchDate` (gt, ge, lt, le, eq, ne)
|
|
18740
18695
|
- `batchNumber` (ne, eq)
|
|
18741
18696
|
- `batchAmount` (gt, ge, lt, le, eq, ne)
|
|
@@ -18745,7 +18700,7 @@ List of field names accepted:
|
|
|
18745
18700
|
- `orgName` (ne, eq, ct, nct, nin, in)
|
|
18746
18701
|
- `paypointId` (ne, eq)
|
|
18747
18702
|
- `externalPaypointID` (ct, nct, eq, ne)
|
|
18748
|
-
|
|
18703
|
+
Accepted parameters:
|
|
18749
18704
|
- limitRecord: max number of records for query (default="20", "0" or negative value for all)
|
|
18750
18705
|
- fromRecord: initial record in query
|
|
18751
18706
|
|
|
@@ -18868,9 +18823,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
18868
18823
|
<Info>
|
|
18869
18824
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
18870
18825
|
|
|
18871
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
18872
|
-
|
|
18873
|
-
For example:
|
|
18826
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
18874
18827
|
|
|
18875
18828
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
18876
18829
|
|
|
@@ -18881,7 +18834,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
18881
18834
|
|
|
18882
18835
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
18883
18836
|
|
|
18884
|
-
|
|
18837
|
+
**Accepted field names:**
|
|
18885
18838
|
- `status` (in, nin, eq, ne)
|
|
18886
18839
|
- `billNumber` (ct, nct, eq, ne)
|
|
18887
18840
|
- `billDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -18897,7 +18850,7 @@ List of field names accepted:
|
|
|
18897
18850
|
- `paypointDba` (ne, eq, ct, nct)
|
|
18898
18851
|
- `orgName` (ne, eq, ct, nct)
|
|
18899
18852
|
|
|
18900
|
-
|
|
18853
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
18901
18854
|
- eq or empty => equal
|
|
18902
18855
|
- gt => greater than
|
|
18903
18856
|
- ge => greater or equal
|
|
@@ -18909,7 +18862,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
18909
18862
|
- in => inside array separated by "|"
|
|
18910
18863
|
- nin => not inside array separated by "|"
|
|
18911
18864
|
|
|
18912
|
-
|
|
18865
|
+
Accepted parameters:
|
|
18913
18866
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
18914
18867
|
- fromRecord : initial record in query
|
|
18915
18868
|
|
|
@@ -19032,9 +18985,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
19032
18985
|
<Info>
|
|
19033
18986
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
19034
18987
|
|
|
19035
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
19036
|
-
|
|
19037
|
-
For example:
|
|
18988
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
19038
18989
|
|
|
19039
18990
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
19040
18991
|
|
|
@@ -19045,7 +18996,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
19045
18996
|
|
|
19046
18997
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
19047
18998
|
|
|
19048
|
-
|
|
18999
|
+
**Accepted field names:**
|
|
19049
19000
|
- `status` (in, nin, eq, ne)
|
|
19050
19001
|
- `billNumber` (ct, nct, eq, ne)
|
|
19051
19002
|
- `billDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -19061,7 +19012,7 @@ List of field names accepted:
|
|
|
19061
19012
|
- `paypointDba` (ne, eq, ct, nct)
|
|
19062
19013
|
- `orgName` (ne, eq, ct, nct)
|
|
19063
19014
|
|
|
19064
|
-
|
|
19015
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
19065
19016
|
- eq or empty => equal
|
|
19066
19017
|
- gt => greater than
|
|
19067
19018
|
- ge => greater or equal
|
|
@@ -19073,7 +19024,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
19073
19024
|
- in => inside array separated by "|"
|
|
19074
19025
|
- nin => not inside array separated by "|"
|
|
19075
19026
|
|
|
19076
|
-
|
|
19027
|
+
Accepted parameters:
|
|
19077
19028
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
19078
19029
|
- fromRecord : initial record in query
|
|
19079
19030
|
|
|
@@ -19196,9 +19147,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
19196
19147
|
<Info>
|
|
19197
19148
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
19198
19149
|
|
|
19199
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
19200
|
-
|
|
19201
|
-
For example:
|
|
19150
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
19202
19151
|
|
|
19203
19152
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
19204
19153
|
|
|
@@ -19209,7 +19158,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
19209
19158
|
|
|
19210
19159
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
19211
19160
|
|
|
19212
|
-
|
|
19161
|
+
**Accepted field names:**
|
|
19213
19162
|
- `chargebackDate` (gt, ge, lt, le, eq, ne)
|
|
19214
19163
|
- `transId` (ne, eq, ct, nct)
|
|
19215
19164
|
- `method` (in, nin, eq, ne)
|
|
@@ -19246,7 +19195,7 @@ List of field names accepted:
|
|
|
19246
19195
|
- `orgName` (ne, eq, ct, nct)
|
|
19247
19196
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
19248
19197
|
|
|
19249
|
-
|
|
19198
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
19250
19199
|
- eq or empty => equal
|
|
19251
19200
|
- gt => greater than
|
|
19252
19201
|
- ge => greater or equal
|
|
@@ -19258,7 +19207,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
19258
19207
|
- in => inside array separated by "|"
|
|
19259
19208
|
- nin => not inside array separated by "|"
|
|
19260
19209
|
|
|
19261
|
-
|
|
19210
|
+
Accepted parameters:
|
|
19262
19211
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
19263
19212
|
- fromRecord : initial record in query
|
|
19264
19213
|
|
|
@@ -19381,9 +19330,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
19381
19330
|
<Info>
|
|
19382
19331
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
19383
19332
|
|
|
19384
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
19385
|
-
|
|
19386
|
-
For example:
|
|
19333
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
19387
19334
|
|
|
19388
19335
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
19389
19336
|
|
|
@@ -19394,7 +19341,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
19394
19341
|
|
|
19395
19342
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
19396
19343
|
|
|
19397
|
-
|
|
19344
|
+
**Accepted field names:**
|
|
19398
19345
|
- `chargebackDate` (gt, ge, lt, le, eq, ne)
|
|
19399
19346
|
- `transId` (ne, eq, ct, nct)
|
|
19400
19347
|
- `method` (in, nin, eq, ne)
|
|
@@ -19431,7 +19378,7 @@ List of field names accepted:
|
|
|
19431
19378
|
- `orgName` (ne, eq, ct, nct)
|
|
19432
19379
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
19433
19380
|
|
|
19434
|
-
|
|
19381
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
19435
19382
|
- eq or empty => equal
|
|
19436
19383
|
- gt => greater than
|
|
19437
19384
|
- ge => greater or equal
|
|
@@ -19443,7 +19390,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
19443
19390
|
- in => inside array separated by "|"
|
|
19444
19391
|
- nin => not inside array separated by "|"
|
|
19445
19392
|
|
|
19446
|
-
|
|
19393
|
+
Accepted parameters:
|
|
19447
19394
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
19448
19395
|
- fromRecord : initial record in query
|
|
19449
19396
|
|
|
@@ -19566,9 +19513,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
19566
19513
|
<Info>
|
|
19567
19514
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
19568
19515
|
|
|
19569
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
19570
|
-
|
|
19571
|
-
For example:
|
|
19516
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
19572
19517
|
|
|
19573
19518
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
19574
19519
|
|
|
@@ -19579,7 +19524,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
19579
19524
|
|
|
19580
19525
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
19581
19526
|
|
|
19582
|
-
**
|
|
19527
|
+
**Accepted field names:**
|
|
19583
19528
|
- `createdDate` (gt, ge, lt, le, eq, ne)
|
|
19584
19529
|
- `customernumber` (ne, eq, ct, nct)
|
|
19585
19530
|
- `firstname` (ne, eq, ct, nct)
|
|
@@ -19608,7 +19553,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
19608
19553
|
- `paypointDba` (ne, eq, ct, nct)
|
|
19609
19554
|
- `orgName` (ne, eq, ct, nct)
|
|
19610
19555
|
|
|
19611
|
-
**
|
|
19556
|
+
**Accepted comparison operators - enclosed between parentheses:**
|
|
19612
19557
|
- eq or empty => equal
|
|
19613
19558
|
- gt => greater than
|
|
19614
19559
|
- ge => greater or equal
|
|
@@ -19620,7 +19565,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
19620
19565
|
- in => inside array separated by "|"
|
|
19621
19566
|
- nin => not inside array separated by "|"
|
|
19622
19567
|
|
|
19623
|
-
**
|
|
19568
|
+
**Accepted parameters:**
|
|
19624
19569
|
- limitRecord: max number of records for query (default="20", "0" or negative value for all)
|
|
19625
19570
|
- fromRecord: initial record in query
|
|
19626
19571
|
|
|
@@ -19744,9 +19689,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
19744
19689
|
<Info>
|
|
19745
19690
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
19746
19691
|
|
|
19747
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
19748
|
-
|
|
19749
|
-
For example:
|
|
19692
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
19750
19693
|
|
|
19751
19694
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
19752
19695
|
|
|
@@ -19757,7 +19700,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
19757
19700
|
|
|
19758
19701
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
19759
19702
|
|
|
19760
|
-
**
|
|
19703
|
+
**Accepted field names:**
|
|
19761
19704
|
- `createdDate` (gt, ge, lt, le, eq, ne)
|
|
19762
19705
|
- `customernumber` (ne, eq, ct, nct)
|
|
19763
19706
|
- `firstname` (ne, eq, ct, nct)
|
|
@@ -19786,7 +19729,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
19786
19729
|
- `paypointDba` (ne, eq, ct, nct)
|
|
19787
19730
|
- `orgName` (ne, eq, ct, nct)
|
|
19788
19731
|
|
|
19789
|
-
**
|
|
19732
|
+
**Accepted comparison operators - enclosed between parentheses:**
|
|
19790
19733
|
- eq or empty => equal
|
|
19791
19734
|
- gt => greater than
|
|
19792
19735
|
- ge => greater or equal
|
|
@@ -19798,7 +19741,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
19798
19741
|
- in => inside array separated by "|"
|
|
19799
19742
|
- nin => not inside array separated by "|"
|
|
19800
19743
|
|
|
19801
|
-
**
|
|
19744
|
+
**Accepted parameters:**
|
|
19802
19745
|
- limitRecord: max number of records for query (default="20", "0" or negative value for all)
|
|
19803
19746
|
- fromRecord: initial record in query
|
|
19804
19747
|
|
|
@@ -19922,9 +19865,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
19922
19865
|
<Info>
|
|
19923
19866
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
19924
19867
|
|
|
19925
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
19926
|
-
|
|
19927
|
-
For example:
|
|
19868
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
19928
19869
|
|
|
19929
19870
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
19930
19871
|
|
|
@@ -19935,7 +19876,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
19935
19876
|
|
|
19936
19877
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
19937
19878
|
|
|
19938
|
-
|
|
19879
|
+
**Accepted field names:**
|
|
19939
19880
|
- `invoiceDate` (gt, ge, lt, le, eq, ne)
|
|
19940
19881
|
- `dueDate` (gt, ge, lt, le, eq, ne)
|
|
19941
19882
|
- `sentDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -19975,7 +19916,7 @@ List of field names accepted:
|
|
|
19975
19916
|
- `orgName` (ne, eq, ct, nct)
|
|
19976
19917
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
19977
19918
|
|
|
19978
|
-
|
|
19919
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
19979
19920
|
- eq or empty => equal
|
|
19980
19921
|
- gt => greater than
|
|
19981
19922
|
- ge => greater or equal
|
|
@@ -19987,7 +19928,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
19987
19928
|
- in => inside array
|
|
19988
19929
|
- nin => not inside array
|
|
19989
19930
|
|
|
19990
|
-
|
|
19931
|
+
Accepted parameters:
|
|
19991
19932
|
- `limitRecord` : max number of records for query (default="20", "0" or negative value for all)
|
|
19992
19933
|
- `fromRecord` : initial record in query
|
|
19993
19934
|
|
|
@@ -20110,9 +20051,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
20110
20051
|
<Info>
|
|
20111
20052
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
20112
20053
|
|
|
20113
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
20114
|
-
|
|
20115
|
-
For example:
|
|
20054
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
20116
20055
|
|
|
20117
20056
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
20118
20057
|
|
|
@@ -20123,7 +20062,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
20123
20062
|
|
|
20124
20063
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
20125
20064
|
|
|
20126
|
-
|
|
20065
|
+
**Accepted field names:**
|
|
20127
20066
|
- `invoiceDate` (gt, ge, lt, le, eq, ne)
|
|
20128
20067
|
- `dueDate` (gt, ge, lt, le, eq, ne)
|
|
20129
20068
|
- `sentDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -20163,7 +20102,7 @@ List of field names accepted:
|
|
|
20163
20102
|
- `orgName` (ne, eq, ct, nct)
|
|
20164
20103
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
20165
20104
|
|
|
20166
|
-
|
|
20105
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
20167
20106
|
- eq or empty => equal
|
|
20168
20107
|
- gt => greater than
|
|
20169
20108
|
- ge => greater or equal
|
|
@@ -20175,7 +20114,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
20175
20114
|
- in => inside array
|
|
20176
20115
|
- nin => not inside array
|
|
20177
20116
|
|
|
20178
|
-
|
|
20117
|
+
Accepted parameters:
|
|
20179
20118
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
20180
20119
|
- fromRecord : initial record in query
|
|
20181
20120
|
|
|
@@ -20298,9 +20237,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
20298
20237
|
<Info>
|
|
20299
20238
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
20300
20239
|
|
|
20301
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
20302
|
-
|
|
20303
|
-
For example:
|
|
20240
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
20304
20241
|
|
|
20305
20242
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
20306
20243
|
|
|
@@ -20311,7 +20248,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
20311
20248
|
|
|
20312
20249
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
20313
20250
|
|
|
20314
|
-
|
|
20251
|
+
**Accepted field names:**
|
|
20315
20252
|
- `name` (ct, nct, eq, ne)
|
|
20316
20253
|
- `type` (ne, eq)
|
|
20317
20254
|
- `contactName` (ct, nct, eq, ne)
|
|
@@ -20326,7 +20263,7 @@ List of field names accepted:
|
|
|
20326
20263
|
- `hasBilling` any value greater than zero is taken as TRUE otherwise is FALSE
|
|
20327
20264
|
- `hasResidual` any value greater than zero is taken as TRUE otherwise is FALSE
|
|
20328
20265
|
|
|
20329
|
-
|
|
20266
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
20330
20267
|
- eq or empty => equal
|
|
20331
20268
|
- gt => greater than
|
|
20332
20269
|
- ge => greater or equal
|
|
@@ -20338,7 +20275,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
20338
20275
|
- in => inside array
|
|
20339
20276
|
- nin => not inside array
|
|
20340
20277
|
|
|
20341
|
-
|
|
20278
|
+
Accepted parameters:
|
|
20342
20279
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
20343
20280
|
- fromRecord : initial record in query
|
|
20344
20281
|
|
|
@@ -20461,9 +20398,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
20461
20398
|
<Info>
|
|
20462
20399
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
20463
20400
|
|
|
20464
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
20465
|
-
|
|
20466
|
-
For example:
|
|
20401
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
20467
20402
|
|
|
20468
20403
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
20469
20404
|
|
|
@@ -20474,7 +20409,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
20474
20409
|
|
|
20475
20410
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
20476
20411
|
|
|
20477
|
-
|
|
20412
|
+
**Accepted field names:**
|
|
20478
20413
|
- `status` (in, nin, eq, ne)
|
|
20479
20414
|
- `transactionDate` (gt, ge, lt, le, eq, ne)
|
|
20480
20415
|
- `billNumber` (ct, nct)
|
|
@@ -20488,7 +20423,7 @@ List of field names accepted:
|
|
|
20488
20423
|
- `paypointDba` (ne, eq, ct, nct)
|
|
20489
20424
|
- `orgName` (ne, eq, ct, nct)
|
|
20490
20425
|
|
|
20491
|
-
|
|
20426
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
20492
20427
|
- eq or empty => equal
|
|
20493
20428
|
- gt => greater than
|
|
20494
20429
|
- ge => greater or equal
|
|
@@ -20500,7 +20435,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
20500
20435
|
- in => inside array separated by "|"
|
|
20501
20436
|
- nin => not inside array separated by "|"
|
|
20502
20437
|
|
|
20503
|
-
|
|
20438
|
+
Accepted parameters:
|
|
20504
20439
|
- limitRecord: max number of records for query (default="20", "0" or negative value for all)
|
|
20505
20440
|
- fromRecord: initial record in query
|
|
20506
20441
|
|
|
@@ -20623,9 +20558,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
20623
20558
|
<Info>
|
|
20624
20559
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
20625
20560
|
|
|
20626
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
20627
|
-
|
|
20628
|
-
For example:
|
|
20561
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
20629
20562
|
|
|
20630
20563
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
20631
20564
|
|
|
@@ -20636,7 +20569,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
20636
20569
|
|
|
20637
20570
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
20638
20571
|
|
|
20639
|
-
|
|
20572
|
+
**Accepted field names:**
|
|
20640
20573
|
- `status` (in, nin, eq, ne)
|
|
20641
20574
|
- `transactionDate` (gt, ge, lt, le, eq, ne)
|
|
20642
20575
|
- `billNumber` (ct, nct)
|
|
@@ -20650,7 +20583,7 @@ List of field names accepted:
|
|
|
20650
20583
|
- `paypointDba` (ne, eq, ct, nct)
|
|
20651
20584
|
- `orgName` (ne, eq, ct, nct)
|
|
20652
20585
|
|
|
20653
|
-
|
|
20586
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
20654
20587
|
- eq or empty => equal
|
|
20655
20588
|
- gt => greater than
|
|
20656
20589
|
- ge => greater or equal
|
|
@@ -20662,7 +20595,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
20662
20595
|
- in => inside array separated by "|"
|
|
20663
20596
|
- nin => not inside array separated by "|"
|
|
20664
20597
|
|
|
20665
|
-
|
|
20598
|
+
Accepted parameters:
|
|
20666
20599
|
- limitRecord: max number of records for query (default="20", "0" or negative value for all)
|
|
20667
20600
|
- fromRecord: initial record in query
|
|
20668
20601
|
|
|
@@ -20785,9 +20718,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
20785
20718
|
<Info>
|
|
20786
20719
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
20787
20720
|
|
|
20788
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
20789
|
-
|
|
20790
|
-
For example:
|
|
20721
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
20791
20722
|
|
|
20792
20723
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
20793
20724
|
|
|
@@ -20798,7 +20729,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
20798
20729
|
|
|
20799
20730
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
20800
20731
|
|
|
20801
|
-
|
|
20732
|
+
**Accepted field names:**
|
|
20802
20733
|
- `createdAt` (gt, ge, lt, le, eq, ne)
|
|
20803
20734
|
- `startDate` (gt, ge, lt, le, eq, ne)
|
|
20804
20735
|
- `dbaname` (ct, nct)
|
|
@@ -20814,7 +20745,7 @@ List of field names accepted:
|
|
|
20814
20745
|
- `contactName` (ct, nct)
|
|
20815
20746
|
- `orgParentname` (ct, nct)
|
|
20816
20747
|
|
|
20817
|
-
|
|
20748
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
20818
20749
|
- eq or empty => equal
|
|
20819
20750
|
- gt => greater than
|
|
20820
20751
|
- ge => greater or equal
|
|
@@ -20826,7 +20757,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
20826
20757
|
- in => inside array
|
|
20827
20758
|
- nin => not inside array
|
|
20828
20759
|
|
|
20829
|
-
|
|
20760
|
+
Accepted parameters:
|
|
20830
20761
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
20831
20762
|
- fromRecord : initial record in query
|
|
20832
20763
|
|
|
@@ -20949,9 +20880,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
20949
20880
|
<Info>
|
|
20950
20881
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
20951
20882
|
|
|
20952
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
20953
|
-
|
|
20954
|
-
For example:
|
|
20883
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
20955
20884
|
|
|
20956
20885
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
20957
20886
|
|
|
@@ -20962,7 +20891,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
20962
20891
|
|
|
20963
20892
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
20964
20893
|
|
|
20965
|
-
|
|
20894
|
+
**Accepted field names:**
|
|
20966
20895
|
- `settlementDate` (gt, ge, lt, le, eq, ne)
|
|
20967
20896
|
- `transId` (ne, eq, ct, nct)
|
|
20968
20897
|
- `gatewayTransId` (ne, eq, ct, nct)
|
|
@@ -20998,7 +20927,7 @@ List of field names accepted:
|
|
|
20998
20927
|
- `orgName` (ne, eq, ct, nct)
|
|
20999
20928
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
21000
20929
|
|
|
21001
|
-
|
|
20930
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
21002
20931
|
- eq or empty => equal
|
|
21003
20932
|
- gt => greater than
|
|
21004
20933
|
- ge => greater or equal
|
|
@@ -21010,7 +20939,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
21010
20939
|
- in => inside array separated by "|"
|
|
21011
20940
|
- nin => not inside array separated by "|"
|
|
21012
20941
|
|
|
21013
|
-
|
|
20942
|
+
Accepted parameters:
|
|
21014
20943
|
- limitRecord: max number of records for query (default="20", "0" or negative value for all)
|
|
21015
20944
|
- fromRecord: initial record in query
|
|
21016
20945
|
|
|
@@ -21133,9 +21062,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
21133
21062
|
<Info>
|
|
21134
21063
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
21135
21064
|
|
|
21136
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
21137
|
-
|
|
21138
|
-
For example:
|
|
21065
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
21139
21066
|
|
|
21140
21067
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
21141
21068
|
|
|
@@ -21146,7 +21073,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
21146
21073
|
|
|
21147
21074
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
21148
21075
|
|
|
21149
|
-
|
|
21076
|
+
**Accepted field names:**
|
|
21150
21077
|
- `settlementDate` (gt, ge, lt, le, eq, ne)
|
|
21151
21078
|
- `transId` (ne, eq, ct, nct)
|
|
21152
21079
|
- `gatewayTransId` (ne, eq, ct, nct)
|
|
@@ -21182,7 +21109,7 @@ List of field names accepted:
|
|
|
21182
21109
|
- `orgName` (ne, eq, ct, nct)
|
|
21183
21110
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
21184
21111
|
|
|
21185
|
-
|
|
21112
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
21186
21113
|
- eq or empty => equal
|
|
21187
21114
|
- gt => greater than
|
|
21188
21115
|
- ge => greater or equal
|
|
@@ -21194,7 +21121,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
21194
21121
|
- in => inside array separated by "|"
|
|
21195
21122
|
- nin => not inside array separated by "|"
|
|
21196
21123
|
|
|
21197
|
-
|
|
21124
|
+
Accepted parameters:
|
|
21198
21125
|
- limitRecord: max number of records for query (default="20", "0" or negative value for all)
|
|
21199
21126
|
- fromRecord: initial record in query
|
|
21200
21127
|
|
|
@@ -21317,9 +21244,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
21317
21244
|
<Info>
|
|
21318
21245
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
21319
21246
|
|
|
21320
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
21321
|
-
|
|
21322
|
-
For example:
|
|
21247
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
21323
21248
|
|
|
21324
21249
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
21325
21250
|
|
|
@@ -21330,7 +21255,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
21330
21255
|
|
|
21331
21256
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
21332
21257
|
|
|
21333
|
-
|
|
21258
|
+
**Accepted field names:**
|
|
21334
21259
|
- `startDate` (gt, ge, lt, le, eq, ne)
|
|
21335
21260
|
- `endDate` (gt, ge, lt, le, eq, ne)
|
|
21336
21261
|
- `nextDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -21368,7 +21293,7 @@ List of field names accepted:
|
|
|
21368
21293
|
- `orgName` (ne, eq, ct, nct)
|
|
21369
21294
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
21370
21295
|
|
|
21371
|
-
|
|
21296
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
21372
21297
|
- eq or empty => equal
|
|
21373
21298
|
- gt => greater than
|
|
21374
21299
|
- ge => greater or equal
|
|
@@ -21380,7 +21305,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
21380
21305
|
- in => inside array
|
|
21381
21306
|
- nin => not inside array
|
|
21382
21307
|
|
|
21383
|
-
|
|
21308
|
+
Accepted parameters:
|
|
21384
21309
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
21385
21310
|
- fromRecord : initial record in query
|
|
21386
21311
|
|
|
@@ -21503,9 +21428,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
21503
21428
|
<Info>
|
|
21504
21429
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
21505
21430
|
|
|
21506
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
21507
|
-
|
|
21508
|
-
For example:
|
|
21431
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
21509
21432
|
|
|
21510
21433
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
21511
21434
|
|
|
@@ -21516,7 +21439,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
21516
21439
|
|
|
21517
21440
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
21518
21441
|
|
|
21519
|
-
|
|
21442
|
+
**Accepted field names:**
|
|
21520
21443
|
- `startDate` (gt, ge, lt, le, eq, ne)
|
|
21521
21444
|
- `endDate` (gt, ge, lt, le, eq, ne)
|
|
21522
21445
|
- `nextDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -21554,7 +21477,7 @@ List of field names accepted:
|
|
|
21554
21477
|
- `orgName` (ne, eq, ct, nct)
|
|
21555
21478
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
21556
21479
|
|
|
21557
|
-
|
|
21480
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
21558
21481
|
- eq or empty => equal
|
|
21559
21482
|
- gt => greater than
|
|
21560
21483
|
- ge => greater or equal
|
|
@@ -21566,7 +21489,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
21566
21489
|
- in => inside array
|
|
21567
21490
|
- nin => not inside array
|
|
21568
21491
|
|
|
21569
|
-
|
|
21492
|
+
Accepted parameters:
|
|
21570
21493
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
21571
21494
|
- fromRecord : initial record in query
|
|
21572
21495
|
|
|
@@ -21689,9 +21612,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
21689
21612
|
<Info>
|
|
21690
21613
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
21691
21614
|
|
|
21692
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
21693
|
-
|
|
21694
|
-
For example:
|
|
21615
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
21695
21616
|
|
|
21696
21617
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
21697
21618
|
|
|
@@ -21702,7 +21623,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
21702
21623
|
|
|
21703
21624
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
21704
21625
|
|
|
21705
|
-
|
|
21626
|
+
**Accepted field names:**
|
|
21706
21627
|
- `transactionDate` (gt, ge, lt, le, eq, ne)
|
|
21707
21628
|
- `transId` (ne, eq, ct, nct)
|
|
21708
21629
|
- `gatewayTransId` (ne, eq, ct, nct)
|
|
@@ -21744,7 +21665,7 @@ List of field names accepted:
|
|
|
21744
21665
|
- `customerShippingCountry` (ct, nct, eq, ne)
|
|
21745
21666
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
21746
21667
|
|
|
21747
|
-
|
|
21668
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
21748
21669
|
- eq or empty => equal
|
|
21749
21670
|
- gt => greater than
|
|
21750
21671
|
- ge => greater or equal
|
|
@@ -21756,7 +21677,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
21756
21677
|
- in => inside array
|
|
21757
21678
|
- nin => not inside array
|
|
21758
21679
|
|
|
21759
|
-
|
|
21680
|
+
Accepted parameters:
|
|
21760
21681
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
21761
21682
|
- fromRecord : initial record in query
|
|
21762
21683
|
|
|
@@ -21879,9 +21800,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
21879
21800
|
<Info>
|
|
21880
21801
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
21881
21802
|
|
|
21882
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
21883
|
-
|
|
21884
|
-
For example:
|
|
21803
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
21885
21804
|
|
|
21886
21805
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
21887
21806
|
|
|
@@ -21892,7 +21811,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
21892
21811
|
|
|
21893
21812
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
21894
21813
|
|
|
21895
|
-
|
|
21814
|
+
**Accepted field names:**
|
|
21896
21815
|
- `transactionDate` (gt, ge, lt, le, eq, ne)
|
|
21897
21816
|
- `transId` (ne, eq, ct, nct)
|
|
21898
21817
|
- `gatewayTransId` (ne, eq, ct, nct)
|
|
@@ -21934,7 +21853,7 @@ List of field names accepted:
|
|
|
21934
21853
|
- `customerShippingCountry` (ct, nct, eq, ne)
|
|
21935
21854
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
21936
21855
|
|
|
21937
|
-
|
|
21856
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
21938
21857
|
- eq or empty => equal
|
|
21939
21858
|
- gt => greater than
|
|
21940
21859
|
- ge => greater or equal
|
|
@@ -21946,7 +21865,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
21946
21865
|
- in => inside array
|
|
21947
21866
|
- nin => not inside array
|
|
21948
21867
|
|
|
21949
|
-
|
|
21868
|
+
Accepted parameters:
|
|
21950
21869
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
21951
21870
|
- fromRecord : initial record in query
|
|
21952
21871
|
|
|
@@ -22079,9 +21998,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
22079
21998
|
<Info>
|
|
22080
21999
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
22081
22000
|
|
|
22082
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
22083
|
-
|
|
22084
|
-
For example:
|
|
22001
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
22085
22002
|
|
|
22086
22003
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
22087
22004
|
|
|
@@ -22092,7 +22009,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
22092
22009
|
|
|
22093
22010
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
22094
22011
|
|
|
22095
|
-
|
|
22012
|
+
**Accepted field names:**
|
|
22096
22013
|
|
|
22097
22014
|
- `grossAmount` (gt, ge, lt, le, eq, ne)
|
|
22098
22015
|
|
|
@@ -22233,9 +22150,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
22233
22150
|
<Info>
|
|
22234
22151
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
22235
22152
|
|
|
22236
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
22237
|
-
|
|
22238
|
-
For example:
|
|
22153
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
22239
22154
|
|
|
22240
22155
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
22241
22156
|
|
|
@@ -22246,7 +22161,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
22246
22161
|
|
|
22247
22162
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
22248
22163
|
|
|
22249
|
-
|
|
22164
|
+
**Accepted field names:**
|
|
22250
22165
|
- `transferDate` (gt, ge, lt, le, eq, ne)
|
|
22251
22166
|
|
|
22252
22167
|
- `grossAmount` (gt, ge, lt, le, eq, ne)
|
|
@@ -22396,9 +22311,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
22396
22311
|
<Info>
|
|
22397
22312
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
22398
22313
|
|
|
22399
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
22400
|
-
|
|
22401
|
-
For example:
|
|
22314
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
22402
22315
|
|
|
22403
22316
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
22404
22317
|
|
|
@@ -22409,7 +22322,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
22409
22322
|
|
|
22410
22323
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
22411
22324
|
|
|
22412
|
-
|
|
22325
|
+
**Accepted field names:**
|
|
22413
22326
|
- `method` (in, nin, eq, ne)
|
|
22414
22327
|
- `enrollmentStatus` (in, nin, eq, ne)
|
|
22415
22328
|
- `status` (in, nin, eq, ne)
|
|
@@ -22429,7 +22342,7 @@ List of field names accepted:
|
|
|
22429
22342
|
- `paypointDba` (ne, eq, ct, nct)
|
|
22430
22343
|
- `orgName` (ne, eq, ct, nct)
|
|
22431
22344
|
|
|
22432
|
-
|
|
22345
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
22433
22346
|
- eq or empty => equal
|
|
22434
22347
|
- gt => greater than
|
|
22435
22348
|
- ge => greater or equal
|
|
@@ -22441,7 +22354,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
22441
22354
|
- in => inside array separated by "|"
|
|
22442
22355
|
- nin => not inside array separated by "|"
|
|
22443
22356
|
|
|
22444
|
-
|
|
22357
|
+
Accepted parameters:
|
|
22445
22358
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
22446
22359
|
- fromRecord : initial record in query
|
|
22447
22360
|
|
|
@@ -22564,9 +22477,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
22564
22477
|
<Info>
|
|
22565
22478
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
22566
22479
|
|
|
22567
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client
|
|
22568
|
-
|
|
22569
|
-
For example:
|
|
22480
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client, for example:
|
|
22570
22481
|
|
|
22571
22482
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
22572
22483
|
|
|
@@ -22577,7 +22488,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
22577
22488
|
|
|
22578
22489
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
22579
22490
|
|
|
22580
|
-
|
|
22491
|
+
**Accepted field names:**
|
|
22581
22492
|
- `method` (in, nin, eq, ne)
|
|
22582
22493
|
- `enrollmentStatus` (in, nin, eq, ne)
|
|
22583
22494
|
- `status` (in, nin, eq, ne)
|
|
@@ -22597,7 +22508,7 @@ List of field names accepted:
|
|
|
22597
22508
|
- `paypointDba` (ne, eq, ct, nct)
|
|
22598
22509
|
- `orgName` (ne, eq, ct, nct)
|
|
22599
22510
|
|
|
22600
|
-
|
|
22511
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
22601
22512
|
- eq or empty => equal
|
|
22602
22513
|
- gt => greater than
|
|
22603
22514
|
- ge => greater or equal
|
|
@@ -22609,7 +22520,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
22609
22520
|
- in => inside array separated by "|"
|
|
22610
22521
|
- nin => not inside array separated by "|"
|
|
22611
22522
|
|
|
22612
|
-
|
|
22523
|
+
Accepted parameters:
|
|
22613
22524
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
22614
22525
|
- fromRecord : initial record in query
|
|
22615
22526
|
|
|
@@ -22886,7 +22797,7 @@ client.organization.add_organization(
|
|
|
22886
22797
|
</dl>
|
|
22887
22798
|
</details>
|
|
22888
22799
|
|
|
22889
|
-
<details><summary><code>client.organization.<a href="/lib/payabli/organization/client.rb">edit_organization</a>(
|
|
22800
|
+
<details><summary><code>client.organization.<a href="/lib/payabli/organization/client.rb">edit_organization</a>(org_id_path_param:, request) -> Payabli::Types::EditOrganizationResponse</code></summary>
|
|
22890
22801
|
<dl>
|
|
22891
22802
|
<dd>
|
|
22892
22803
|
|
|
@@ -22914,7 +22825,7 @@ Updates an organization's details by ID.
|
|
|
22914
22825
|
|
|
22915
22826
|
```ruby
|
|
22916
22827
|
client.organization.edit_organization(
|
|
22917
|
-
|
|
22828
|
+
org_id_path_param: 123,
|
|
22918
22829
|
contacts: [{
|
|
22919
22830
|
contact_email: "herman@hermanscoatings.com",
|
|
22920
22831
|
contact_name: "Herman Martinez",
|
|
@@ -22925,7 +22836,7 @@ client.organization.edit_organization(
|
|
|
22925
22836
|
org_city: "Johnson City",
|
|
22926
22837
|
org_country: "US",
|
|
22927
22838
|
org_entry_name: "pilgrim-planner",
|
|
22928
|
-
|
|
22839
|
+
org_id: "123",
|
|
22929
22840
|
org_name: "Pilgrim Planner",
|
|
22930
22841
|
org_state: "TN",
|
|
22931
22842
|
org_timezone: -5,
|
|
@@ -22947,7 +22858,7 @@ client.organization.edit_organization(
|
|
|
22947
22858
|
<dl>
|
|
22948
22859
|
<dd>
|
|
22949
22860
|
|
|
22950
|
-
**
|
|
22861
|
+
**org_id_path_param:** `Integer` — The numeric identifier for organization, assigned by Payabli.
|
|
22951
22862
|
|
|
22952
22863
|
</dd>
|
|
22953
22864
|
</dl>
|
|
@@ -23027,7 +22938,7 @@ client.organization.edit_organization(
|
|
|
23027
22938
|
<dl>
|
|
23028
22939
|
<dd>
|
|
23029
22940
|
|
|
23030
|
-
**
|
|
22941
|
+
**org_id:** `String`
|
|
23031
22942
|
|
|
23032
22943
|
</dd>
|
|
23033
22944
|
</dl>
|
|
@@ -24053,7 +23964,7 @@ For example, `w` groups the results by week.
|
|
|
24053
23964
|
<dl>
|
|
24054
23965
|
<dd>
|
|
24055
23966
|
|
|
24056
|
-
Create a new notification or
|
|
23967
|
+
Create a new notification or autogenerated report.
|
|
24057
23968
|
</dd>
|
|
24058
23969
|
</dl>
|
|
24059
23970
|
</dd>
|
|
@@ -24070,7 +23981,7 @@ Create a new notification or auto-generated report.
|
|
|
24070
23981
|
```ruby
|
|
24071
23982
|
client.notification.add_notification(
|
|
24072
23983
|
content: {
|
|
24073
|
-
event_type: "
|
|
23984
|
+
event_type: "createdapplication"
|
|
24074
23985
|
},
|
|
24075
23986
|
frequency: "untilcancelled",
|
|
24076
23987
|
method_: "web",
|
|
@@ -24125,7 +24036,7 @@ client.notification.add_notification(
|
|
|
24125
24036
|
<dl>
|
|
24126
24037
|
<dd>
|
|
24127
24038
|
|
|
24128
|
-
Retrieves a single notification or
|
|
24039
|
+
Retrieves a single notification or autogenerated report's details.
|
|
24129
24040
|
</dd>
|
|
24130
24041
|
</dl>
|
|
24131
24042
|
</dd>
|
|
@@ -24187,7 +24098,7 @@ client.notification.get_notification(n_id: "1717")
|
|
|
24187
24098
|
<dl>
|
|
24188
24099
|
<dd>
|
|
24189
24100
|
|
|
24190
|
-
Update a notification or
|
|
24101
|
+
Update a notification or autogenerated report.
|
|
24191
24102
|
</dd>
|
|
24192
24103
|
</dl>
|
|
24193
24104
|
</dd>
|
|
@@ -24205,7 +24116,7 @@ Update a notification or auto-generated report.
|
|
|
24205
24116
|
client.notification.update_notification(
|
|
24206
24117
|
n_id: "1717",
|
|
24207
24118
|
content: {
|
|
24208
|
-
event_type: "
|
|
24119
|
+
event_type: "approvedpayment"
|
|
24209
24120
|
},
|
|
24210
24121
|
frequency: "untilcancelled",
|
|
24211
24122
|
method_: "email",
|
|
@@ -24268,7 +24179,7 @@ client.notification.update_notification(
|
|
|
24268
24179
|
<dl>
|
|
24269
24180
|
<dd>
|
|
24270
24181
|
|
|
24271
|
-
Deletes a single notification or
|
|
24182
|
+
Deletes a single notification or autogenerated report.
|
|
24272
24183
|
</dd>
|
|
24273
24184
|
</dl>
|
|
24274
24185
|
</dd>
|
|
@@ -26185,7 +26096,7 @@ Authorizes a transaction for payout.
|
|
|
26185
26096
|
|
|
26186
26097
|
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
26098
|
|
|
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/
|
|
26099
|
+
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
26100
|
|
|
26190
26101
|
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
26102
|
|
|
@@ -26260,6 +26171,18 @@ client.money_out.authorize_out(
|
|
|
26260
26171
|
<dl>
|
|
26261
26172
|
<dd>
|
|
26262
26173
|
|
|
26174
|
+
**same_day_ach:** `Internal::Types::Boolean`
|
|
26175
|
+
|
|
26176
|
+
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.
|
|
26177
|
+
|
|
26178
|
+
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.
|
|
26179
|
+
|
|
26180
|
+
</dd>
|
|
26181
|
+
</dl>
|
|
26182
|
+
|
|
26183
|
+
<dl>
|
|
26184
|
+
<dd>
|
|
26185
|
+
|
|
26263
26186
|
**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
26187
|
|
|
26265
26188
|
</dd>
|
|
@@ -26604,6 +26527,18 @@ client.money_out.capture_all_out(body: %w[2-29 2-28 2-27])
|
|
|
26604
26527
|
<dl>
|
|
26605
26528
|
<dd>
|
|
26606
26529
|
|
|
26530
|
+
**auto_convert_same_day_ach:** `Internal::Types::Boolean`
|
|
26531
|
+
|
|
26532
|
+
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.
|
|
26533
|
+
|
|
26534
|
+
This parameter has no effect on payouts that weren't authorized for same-day ACH.
|
|
26535
|
+
|
|
26536
|
+
</dd>
|
|
26537
|
+
</dl>
|
|
26538
|
+
|
|
26539
|
+
<dl>
|
|
26540
|
+
<dd>
|
|
26541
|
+
|
|
26607
26542
|
**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
26543
|
|
|
26609
26544
|
</dd>
|
|
@@ -26684,6 +26619,18 @@ client.money_out.capture_out(reference_id: "129-219")
|
|
|
26684
26619
|
<dl>
|
|
26685
26620
|
<dd>
|
|
26686
26621
|
|
|
26622
|
+
**auto_convert_same_day_ach:** `Internal::Types::Boolean`
|
|
26623
|
+
|
|
26624
|
+
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.
|
|
26625
|
+
|
|
26626
|
+
This parameter has no effect on payouts that weren't authorized for same-day ACH.
|
|
26627
|
+
|
|
26628
|
+
</dd>
|
|
26629
|
+
</dl>
|
|
26630
|
+
|
|
26631
|
+
<dl>
|
|
26632
|
+
<dd>
|
|
26633
|
+
|
|
26687
26634
|
**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
26635
|
|
|
26689
26636
|
</dd>
|
|
@@ -28168,7 +28115,7 @@ client.charge_backs.get_chargeback(id: 1000000)
|
|
|
28168
28115
|
<dl>
|
|
28169
28116
|
<dd>
|
|
28170
28117
|
|
|
28171
|
-
**id:** `Integer` — ID of the chargeback or return record. This is returned as `chargebackID` in the [ReceivedChargeBack](/
|
|
28118
|
+
**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
28119
|
|
|
28173
28120
|
</dd>
|
|
28174
28121
|
</dl>
|
|
@@ -28261,3 +28208,1369 @@ client.charge_backs.get_chargeback_attachment(
|
|
|
28261
28208
|
</dl>
|
|
28262
28209
|
</details>
|
|
28263
28210
|
|
|
28211
|
+
## Case Management
|
|
28212
|
+
<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>
|
|
28213
|
+
<dl>
|
|
28214
|
+
<dd>
|
|
28215
|
+
|
|
28216
|
+
#### 📝 Description
|
|
28217
|
+
|
|
28218
|
+
<dl>
|
|
28219
|
+
<dd>
|
|
28220
|
+
|
|
28221
|
+
<dl>
|
|
28222
|
+
<dd>
|
|
28223
|
+
|
|
28224
|
+
Validates a bank account change for a paypoint without creating a case.
|
|
28225
|
+
Runs the same checks the create endpoint runs, and returns blocking
|
|
28226
|
+
conditions and warnings. Blocking conditions prevent creation; warnings
|
|
28227
|
+
don't.
|
|
28228
|
+
|
|
28229
|
+
Available to both Platform and Enterprise Partners.
|
|
28230
|
+
</dd>
|
|
28231
|
+
</dl>
|
|
28232
|
+
</dd>
|
|
28233
|
+
</dl>
|
|
28234
|
+
|
|
28235
|
+
#### 🔌 Usage
|
|
28236
|
+
|
|
28237
|
+
<dl>
|
|
28238
|
+
<dd>
|
|
28239
|
+
|
|
28240
|
+
<dl>
|
|
28241
|
+
<dd>
|
|
28242
|
+
|
|
28243
|
+
```ruby
|
|
28244
|
+
client.case_management.validate_bank_account_change(
|
|
28245
|
+
paypoint_id: 3040,
|
|
28246
|
+
routing_number: "123456789",
|
|
28247
|
+
account_number: "987654321",
|
|
28248
|
+
account_type: "checking",
|
|
28249
|
+
bank_account_holder_type: "business",
|
|
28250
|
+
bank_account_function: "Deposits",
|
|
28251
|
+
services: {
|
|
28252
|
+
money_in: ["Ach"],
|
|
28253
|
+
money_out: ["Ach"]
|
|
28254
|
+
}
|
|
28255
|
+
)
|
|
28256
|
+
```
|
|
28257
|
+
</dd>
|
|
28258
|
+
</dl>
|
|
28259
|
+
</dd>
|
|
28260
|
+
</dl>
|
|
28261
|
+
|
|
28262
|
+
#### ⚙️ Parameters
|
|
28263
|
+
|
|
28264
|
+
<dl>
|
|
28265
|
+
<dd>
|
|
28266
|
+
|
|
28267
|
+
<dl>
|
|
28268
|
+
<dd>
|
|
28269
|
+
|
|
28270
|
+
**paypoint_id:** `Integer` — The paypoint's numeric identifier.
|
|
28271
|
+
|
|
28272
|
+
</dd>
|
|
28273
|
+
</dl>
|
|
28274
|
+
|
|
28275
|
+
<dl>
|
|
28276
|
+
<dd>
|
|
28277
|
+
|
|
28278
|
+
**routing_number:** `String` — The 9-digit bank routing number.
|
|
28279
|
+
|
|
28280
|
+
</dd>
|
|
28281
|
+
</dl>
|
|
28282
|
+
|
|
28283
|
+
<dl>
|
|
28284
|
+
<dd>
|
|
28285
|
+
|
|
28286
|
+
**account_number:** `String` — The bank account number (4 to 17 digits).
|
|
28287
|
+
|
|
28288
|
+
</dd>
|
|
28289
|
+
</dl>
|
|
28290
|
+
|
|
28291
|
+
<dl>
|
|
28292
|
+
<dd>
|
|
28293
|
+
|
|
28294
|
+
**account_type:** `String` — The account type. Must be `checking` or `savings`.
|
|
28295
|
+
|
|
28296
|
+
</dd>
|
|
28297
|
+
</dl>
|
|
28298
|
+
|
|
28299
|
+
<dl>
|
|
28300
|
+
<dd>
|
|
28301
|
+
|
|
28302
|
+
**bank_account_holder_type:** `String` — The account holder type. Must be `personal` or `business`.
|
|
28303
|
+
|
|
28304
|
+
</dd>
|
|
28305
|
+
</dl>
|
|
28306
|
+
|
|
28307
|
+
<dl>
|
|
28308
|
+
<dd>
|
|
28309
|
+
|
|
28310
|
+
**bank_account_function:** `Payabli::Types::CaseManagementBankAccountFunction`
|
|
28311
|
+
|
|
28312
|
+
</dd>
|
|
28313
|
+
</dl>
|
|
28314
|
+
|
|
28315
|
+
<dl>
|
|
28316
|
+
<dd>
|
|
28317
|
+
|
|
28318
|
+
**services:** `Payabli::Types::BankAccountServices`
|
|
28319
|
+
|
|
28320
|
+
</dd>
|
|
28321
|
+
</dl>
|
|
28322
|
+
|
|
28323
|
+
<dl>
|
|
28324
|
+
<dd>
|
|
28325
|
+
|
|
28326
|
+
**request_options:** `Payabli::CaseManagement::RequestOptions`
|
|
28327
|
+
|
|
28328
|
+
</dd>
|
|
28329
|
+
</dl>
|
|
28330
|
+
</dd>
|
|
28331
|
+
</dl>
|
|
28332
|
+
|
|
28333
|
+
|
|
28334
|
+
</dd>
|
|
28335
|
+
</dl>
|
|
28336
|
+
</details>
|
|
28337
|
+
|
|
28338
|
+
<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>
|
|
28339
|
+
<dl>
|
|
28340
|
+
<dd>
|
|
28341
|
+
|
|
28342
|
+
#### 📝 Description
|
|
28343
|
+
|
|
28344
|
+
<dl>
|
|
28345
|
+
<dd>
|
|
28346
|
+
|
|
28347
|
+
<dl>
|
|
28348
|
+
<dd>
|
|
28349
|
+
|
|
28350
|
+
Creates a bank-account-change case for a paypoint. The account and
|
|
28351
|
+
routing numbers are validated and tokenized before the case is saved —
|
|
28352
|
+
the raw numbers are never stored or returned. The account holder name is
|
|
28353
|
+
taken from the paypoint's legal name. On success the case is created in
|
|
28354
|
+
`Submitted` and asynchronous verification starts.
|
|
28355
|
+
|
|
28356
|
+
Available to both Platform and Enterprise Partners.
|
|
28357
|
+
</dd>
|
|
28358
|
+
</dl>
|
|
28359
|
+
</dd>
|
|
28360
|
+
</dl>
|
|
28361
|
+
|
|
28362
|
+
#### 🔌 Usage
|
|
28363
|
+
|
|
28364
|
+
<dl>
|
|
28365
|
+
<dd>
|
|
28366
|
+
|
|
28367
|
+
<dl>
|
|
28368
|
+
<dd>
|
|
28369
|
+
|
|
28370
|
+
```ruby
|
|
28371
|
+
client.case_management.create_bank_account_change(
|
|
28372
|
+
paypoint_id: 3040,
|
|
28373
|
+
nickname: "Main Settlement Account",
|
|
28374
|
+
bank_name: "First National Bank",
|
|
28375
|
+
routing_number: "123456789",
|
|
28376
|
+
account_number: "987654321",
|
|
28377
|
+
account_type: "checking",
|
|
28378
|
+
bank_account_holder_type: "business",
|
|
28379
|
+
bank_account_function: "Deposits",
|
|
28380
|
+
services: {
|
|
28381
|
+
money_in: ["Ach"],
|
|
28382
|
+
money_out: ["Ach"]
|
|
28383
|
+
},
|
|
28384
|
+
default: true
|
|
28385
|
+
)
|
|
28386
|
+
```
|
|
28387
|
+
</dd>
|
|
28388
|
+
</dl>
|
|
28389
|
+
</dd>
|
|
28390
|
+
</dl>
|
|
28391
|
+
|
|
28392
|
+
#### ⚙️ Parameters
|
|
28393
|
+
|
|
28394
|
+
<dl>
|
|
28395
|
+
<dd>
|
|
28396
|
+
|
|
28397
|
+
<dl>
|
|
28398
|
+
<dd>
|
|
28399
|
+
|
|
28400
|
+
**paypoint_id:** `Integer` — The paypoint's numeric identifier.
|
|
28401
|
+
|
|
28402
|
+
</dd>
|
|
28403
|
+
</dl>
|
|
28404
|
+
|
|
28405
|
+
<dl>
|
|
28406
|
+
<dd>
|
|
28407
|
+
|
|
28408
|
+
**nickname:** `String` — A label for the account.
|
|
28409
|
+
|
|
28410
|
+
</dd>
|
|
28411
|
+
</dl>
|
|
28412
|
+
|
|
28413
|
+
<dl>
|
|
28414
|
+
<dd>
|
|
28415
|
+
|
|
28416
|
+
**bank_name:** `String` — The name of the bank.
|
|
28417
|
+
|
|
28418
|
+
</dd>
|
|
28419
|
+
</dl>
|
|
28420
|
+
|
|
28421
|
+
<dl>
|
|
28422
|
+
<dd>
|
|
28423
|
+
|
|
28424
|
+
**routing_number:** `String` — The 9-digit bank routing number.
|
|
28425
|
+
|
|
28426
|
+
</dd>
|
|
28427
|
+
</dl>
|
|
28428
|
+
|
|
28429
|
+
<dl>
|
|
28430
|
+
<dd>
|
|
28431
|
+
|
|
28432
|
+
**account_number:** `String` — The bank account number (4 to 17 digits).
|
|
28433
|
+
|
|
28434
|
+
</dd>
|
|
28435
|
+
</dl>
|
|
28436
|
+
|
|
28437
|
+
<dl>
|
|
28438
|
+
<dd>
|
|
28439
|
+
|
|
28440
|
+
**account_type:** `String` — The account type. Must be `checking` or `savings`.
|
|
28441
|
+
|
|
28442
|
+
</dd>
|
|
28443
|
+
</dl>
|
|
28444
|
+
|
|
28445
|
+
<dl>
|
|
28446
|
+
<dd>
|
|
28447
|
+
|
|
28448
|
+
**bank_account_holder_type:** `String` — The account holder type. Must be `personal` or `business`.
|
|
28449
|
+
|
|
28450
|
+
</dd>
|
|
28451
|
+
</dl>
|
|
28452
|
+
|
|
28453
|
+
<dl>
|
|
28454
|
+
<dd>
|
|
28455
|
+
|
|
28456
|
+
**bank_account_function:** `Payabli::Types::CaseManagementBankAccountFunction`
|
|
28457
|
+
|
|
28458
|
+
</dd>
|
|
28459
|
+
</dl>
|
|
28460
|
+
|
|
28461
|
+
<dl>
|
|
28462
|
+
<dd>
|
|
28463
|
+
|
|
28464
|
+
**services:** `Payabli::Types::BankAccountServices`
|
|
28465
|
+
|
|
28466
|
+
</dd>
|
|
28467
|
+
</dl>
|
|
28468
|
+
|
|
28469
|
+
<dl>
|
|
28470
|
+
<dd>
|
|
28471
|
+
|
|
28472
|
+
**default:** `Internal::Types::Boolean` — Whether this is the default account for the selected services.
|
|
28473
|
+
|
|
28474
|
+
</dd>
|
|
28475
|
+
</dl>
|
|
28476
|
+
|
|
28477
|
+
<dl>
|
|
28478
|
+
<dd>
|
|
28479
|
+
|
|
28480
|
+
**schedule_for:** `String`
|
|
28481
|
+
|
|
28482
|
+
When to run the change, as a UTC timestamp (trailing `Z`). Must be at
|
|
28483
|
+
least 1 hour and at most 30 days in the future. Omit to run as soon as
|
|
28484
|
+
the case is approved.
|
|
28485
|
+
|
|
28486
|
+
</dd>
|
|
28487
|
+
</dl>
|
|
28488
|
+
|
|
28489
|
+
<dl>
|
|
28490
|
+
<dd>
|
|
28491
|
+
|
|
28492
|
+
**request_options:** `Payabli::CaseManagement::RequestOptions`
|
|
28493
|
+
|
|
28494
|
+
</dd>
|
|
28495
|
+
</dl>
|
|
28496
|
+
</dd>
|
|
28497
|
+
</dl>
|
|
28498
|
+
|
|
28499
|
+
|
|
28500
|
+
</dd>
|
|
28501
|
+
</dl>
|
|
28502
|
+
</details>
|
|
28503
|
+
|
|
28504
|
+
<details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">get_case</a>(uuid:) -> Payabli::Types::CaseResponse</code></summary>
|
|
28505
|
+
<dl>
|
|
28506
|
+
<dd>
|
|
28507
|
+
|
|
28508
|
+
#### 📝 Description
|
|
28509
|
+
|
|
28510
|
+
<dl>
|
|
28511
|
+
<dd>
|
|
28512
|
+
|
|
28513
|
+
<dl>
|
|
28514
|
+
<dd>
|
|
28515
|
+
|
|
28516
|
+
Returns a case by its UUID, including its current state, parameters,
|
|
28517
|
+
state history, verification metadata, and attachments.
|
|
28518
|
+
|
|
28519
|
+
Available to both Platform and Enterprise Partners.
|
|
28520
|
+
</dd>
|
|
28521
|
+
</dl>
|
|
28522
|
+
</dd>
|
|
28523
|
+
</dl>
|
|
28524
|
+
|
|
28525
|
+
#### 🔌 Usage
|
|
28526
|
+
|
|
28527
|
+
<dl>
|
|
28528
|
+
<dd>
|
|
28529
|
+
|
|
28530
|
+
<dl>
|
|
28531
|
+
<dd>
|
|
28532
|
+
|
|
28533
|
+
```ruby
|
|
28534
|
+
client.case_management.get_case(uuid: "9c2b7e14-3a5f-4d21-b8e0-1f6a4c9d2e70")
|
|
28535
|
+
```
|
|
28536
|
+
</dd>
|
|
28537
|
+
</dl>
|
|
28538
|
+
</dd>
|
|
28539
|
+
</dl>
|
|
28540
|
+
|
|
28541
|
+
#### ⚙️ Parameters
|
|
28542
|
+
|
|
28543
|
+
<dl>
|
|
28544
|
+
<dd>
|
|
28545
|
+
|
|
28546
|
+
<dl>
|
|
28547
|
+
<dd>
|
|
28548
|
+
|
|
28549
|
+
**uuid:** `String` — The case's UUID.
|
|
28550
|
+
|
|
28551
|
+
</dd>
|
|
28552
|
+
</dl>
|
|
28553
|
+
|
|
28554
|
+
<dl>
|
|
28555
|
+
<dd>
|
|
28556
|
+
|
|
28557
|
+
**request_options:** `Payabli::CaseManagement::RequestOptions`
|
|
28558
|
+
|
|
28559
|
+
</dd>
|
|
28560
|
+
</dl>
|
|
28561
|
+
</dd>
|
|
28562
|
+
</dl>
|
|
28563
|
+
|
|
28564
|
+
|
|
28565
|
+
</dd>
|
|
28566
|
+
</dl>
|
|
28567
|
+
</details>
|
|
28568
|
+
|
|
28569
|
+
<details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">list_cases</a>(organization_id:) -> Payabli::Types::CaseListResponse</code></summary>
|
|
28570
|
+
<dl>
|
|
28571
|
+
<dd>
|
|
28572
|
+
|
|
28573
|
+
#### 📝 Description
|
|
28574
|
+
|
|
28575
|
+
<dl>
|
|
28576
|
+
<dd>
|
|
28577
|
+
|
|
28578
|
+
<dl>
|
|
28579
|
+
<dd>
|
|
28580
|
+
|
|
28581
|
+
Lists cases for an organization, climbing the platform org hierarchy.
|
|
28582
|
+
Supports pagination and sorting through query parameters, and filtering
|
|
28583
|
+
through repeatable `parameters[field(op)]=value` query parameters (for
|
|
28584
|
+
example `parameters[state(in)]=Assigned|PendingReview`). Filterable
|
|
28585
|
+
fields include `state`, `caseType`, `paypointId`, `createdAt`,
|
|
28586
|
+
`updatedAt`, `scheduleFor`, and `createdBy`.
|
|
28587
|
+
|
|
28588
|
+
Available to both Platform and Enterprise Partners.
|
|
28589
|
+
</dd>
|
|
28590
|
+
</dl>
|
|
28591
|
+
</dd>
|
|
28592
|
+
</dl>
|
|
28593
|
+
|
|
28594
|
+
#### 🔌 Usage
|
|
28595
|
+
|
|
28596
|
+
<dl>
|
|
28597
|
+
<dd>
|
|
28598
|
+
|
|
28599
|
+
<dl>
|
|
28600
|
+
<dd>
|
|
28601
|
+
|
|
28602
|
+
```ruby
|
|
28603
|
+
client.case_management.list_cases(
|
|
28604
|
+
organization_id: 123,
|
|
28605
|
+
from_record: 0,
|
|
28606
|
+
limit_record: 20
|
|
28607
|
+
)
|
|
28608
|
+
```
|
|
28609
|
+
</dd>
|
|
28610
|
+
</dl>
|
|
28611
|
+
</dd>
|
|
28612
|
+
</dl>
|
|
28613
|
+
|
|
28614
|
+
#### ⚙️ Parameters
|
|
28615
|
+
|
|
28616
|
+
<dl>
|
|
28617
|
+
<dd>
|
|
28618
|
+
|
|
28619
|
+
<dl>
|
|
28620
|
+
<dd>
|
|
28621
|
+
|
|
28622
|
+
**organization_id:** `Integer` — The organization's numeric identifier.
|
|
28623
|
+
|
|
28624
|
+
</dd>
|
|
28625
|
+
</dl>
|
|
28626
|
+
|
|
28627
|
+
<dl>
|
|
28628
|
+
<dd>
|
|
28629
|
+
|
|
28630
|
+
**from_record:** `Integer` — The zero-based index of the first record to return.
|
|
28631
|
+
|
|
28632
|
+
</dd>
|
|
28633
|
+
</dl>
|
|
28634
|
+
|
|
28635
|
+
<dl>
|
|
28636
|
+
<dd>
|
|
28637
|
+
|
|
28638
|
+
**limit_record:** `Integer` — The maximum number of records to return (1 to 200).
|
|
28639
|
+
|
|
28640
|
+
</dd>
|
|
28641
|
+
</dl>
|
|
28642
|
+
|
|
28643
|
+
<dl>
|
|
28644
|
+
<dd>
|
|
28645
|
+
|
|
28646
|
+
**sort_by:** `String` — Sort expression, such as `desc(createdAt)` or `asc(state)`. Defaults to `desc(createdAt)`.
|
|
28647
|
+
|
|
28648
|
+
</dd>
|
|
28649
|
+
</dl>
|
|
28650
|
+
|
|
28651
|
+
<dl>
|
|
28652
|
+
<dd>
|
|
28653
|
+
|
|
28654
|
+
**request_options:** `Payabli::CaseManagement::RequestOptions`
|
|
28655
|
+
|
|
28656
|
+
</dd>
|
|
28657
|
+
</dl>
|
|
28658
|
+
</dd>
|
|
28659
|
+
</dl>
|
|
28660
|
+
|
|
28661
|
+
|
|
28662
|
+
</dd>
|
|
28663
|
+
</dl>
|
|
28664
|
+
</details>
|
|
28665
|
+
|
|
28666
|
+
<details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">list_messages</a>(case_uuid:) -> Payabli::Types::MessagePage</code></summary>
|
|
28667
|
+
<dl>
|
|
28668
|
+
<dd>
|
|
28669
|
+
|
|
28670
|
+
#### 📝 Description
|
|
28671
|
+
|
|
28672
|
+
<dl>
|
|
28673
|
+
<dd>
|
|
28674
|
+
|
|
28675
|
+
<dl>
|
|
28676
|
+
<dd>
|
|
28677
|
+
|
|
28678
|
+
Lists the notes on a case, ordered oldest to newest. Cursor-paginated.
|
|
28679
|
+
|
|
28680
|
+
Available to both Platform and Enterprise Partners.
|
|
28681
|
+
</dd>
|
|
28682
|
+
</dl>
|
|
28683
|
+
</dd>
|
|
28684
|
+
</dl>
|
|
28685
|
+
|
|
28686
|
+
#### 🔌 Usage
|
|
28687
|
+
|
|
28688
|
+
<dl>
|
|
28689
|
+
<dd>
|
|
28690
|
+
|
|
28691
|
+
<dl>
|
|
28692
|
+
<dd>
|
|
28693
|
+
|
|
28694
|
+
```ruby
|
|
28695
|
+
client.case_management.list_messages(case_uuid: "9c2b7e14-3a5f-4d21-b8e0-1f6a4c9d2e70")
|
|
28696
|
+
```
|
|
28697
|
+
</dd>
|
|
28698
|
+
</dl>
|
|
28699
|
+
</dd>
|
|
28700
|
+
</dl>
|
|
28701
|
+
|
|
28702
|
+
#### ⚙️ Parameters
|
|
28703
|
+
|
|
28704
|
+
<dl>
|
|
28705
|
+
<dd>
|
|
28706
|
+
|
|
28707
|
+
<dl>
|
|
28708
|
+
<dd>
|
|
28709
|
+
|
|
28710
|
+
**case_uuid:** `String` — The case's UUID.
|
|
28711
|
+
|
|
28712
|
+
</dd>
|
|
28713
|
+
</dl>
|
|
28714
|
+
|
|
28715
|
+
<dl>
|
|
28716
|
+
<dd>
|
|
28717
|
+
|
|
28718
|
+
**limit:** `Integer` — The maximum number of notes to return (default 50, max 200).
|
|
28719
|
+
|
|
28720
|
+
</dd>
|
|
28721
|
+
</dl>
|
|
28722
|
+
|
|
28723
|
+
<dl>
|
|
28724
|
+
<dd>
|
|
28725
|
+
|
|
28726
|
+
**cursor:** `String` — An opaque cursor for the next page.
|
|
28727
|
+
|
|
28728
|
+
</dd>
|
|
28729
|
+
</dl>
|
|
28730
|
+
|
|
28731
|
+
<dl>
|
|
28732
|
+
<dd>
|
|
28733
|
+
|
|
28734
|
+
**request_options:** `Payabli::CaseManagement::RequestOptions`
|
|
28735
|
+
|
|
28736
|
+
</dd>
|
|
28737
|
+
</dl>
|
|
28738
|
+
</dd>
|
|
28739
|
+
</dl>
|
|
28740
|
+
|
|
28741
|
+
|
|
28742
|
+
</dd>
|
|
28743
|
+
</dl>
|
|
28744
|
+
</details>
|
|
28745
|
+
|
|
28746
|
+
<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>
|
|
28747
|
+
<dl>
|
|
28748
|
+
<dd>
|
|
28749
|
+
|
|
28750
|
+
#### 📝 Description
|
|
28751
|
+
|
|
28752
|
+
<dl>
|
|
28753
|
+
<dd>
|
|
28754
|
+
|
|
28755
|
+
<dl>
|
|
28756
|
+
<dd>
|
|
28757
|
+
|
|
28758
|
+
Adds a note to a case.
|
|
28759
|
+
|
|
28760
|
+
Available to both Platform and Enterprise Partners.
|
|
28761
|
+
|
|
28762
|
+
This endpoint is in development and not yet available for API use. To
|
|
28763
|
+
add a note for now, use Case Management in the
|
|
28764
|
+
[Payabli Portal](/guides/pay-ops-portal-bank-account-changes-manage).
|
|
28765
|
+
To read existing notes on a case, use
|
|
28766
|
+
[List case notes](/developers/api-reference/caseManagement/list-case-notes).
|
|
28767
|
+
</dd>
|
|
28768
|
+
</dl>
|
|
28769
|
+
</dd>
|
|
28770
|
+
</dl>
|
|
28771
|
+
|
|
28772
|
+
#### 🔌 Usage
|
|
28773
|
+
|
|
28774
|
+
<dl>
|
|
28775
|
+
<dd>
|
|
28776
|
+
|
|
28777
|
+
<dl>
|
|
28778
|
+
<dd>
|
|
28779
|
+
|
|
28780
|
+
```ruby
|
|
28781
|
+
client.case_management.post_message(
|
|
28782
|
+
case_uuid: "9c2b7e14-3a5f-4d21-b8e0-1f6a4c9d2e70",
|
|
28783
|
+
content: "Reviewed supporting documents; account ownership confirmed."
|
|
28784
|
+
)
|
|
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
|
+
**content:** `String` — The note text (1 to 4000 characters).
|
|
28808
|
+
|
|
28809
|
+
</dd>
|
|
28810
|
+
</dl>
|
|
28811
|
+
|
|
28812
|
+
<dl>
|
|
28813
|
+
<dd>
|
|
28814
|
+
|
|
28815
|
+
**request_options:** `Payabli::CaseManagement::RequestOptions`
|
|
28816
|
+
|
|
28817
|
+
</dd>
|
|
28818
|
+
</dl>
|
|
28819
|
+
</dd>
|
|
28820
|
+
</dl>
|
|
28821
|
+
|
|
28822
|
+
|
|
28823
|
+
</dd>
|
|
28824
|
+
</dl>
|
|
28825
|
+
</details>
|
|
28826
|
+
|
|
28827
|
+
<details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">list_transitions</a>(uuid:) -> Payabli::Types::AvailableTransitionsResponse</code></summary>
|
|
28828
|
+
<dl>
|
|
28829
|
+
<dd>
|
|
28830
|
+
|
|
28831
|
+
#### 📝 Description
|
|
28832
|
+
|
|
28833
|
+
<dl>
|
|
28834
|
+
<dd>
|
|
28835
|
+
|
|
28836
|
+
<dl>
|
|
28837
|
+
<dd>
|
|
28838
|
+
|
|
28839
|
+
Lists the review actions currently available on a case. The list is
|
|
28840
|
+
empty when no user action is available (for example while the case is
|
|
28841
|
+
mid-automation).
|
|
28842
|
+
|
|
28843
|
+
Available to both Platform and Enterprise Partners, though only
|
|
28844
|
+
Enterprise Partners can fire the returned actions.
|
|
28845
|
+
</dd>
|
|
28846
|
+
</dl>
|
|
28847
|
+
</dd>
|
|
28848
|
+
</dl>
|
|
28849
|
+
|
|
28850
|
+
#### 🔌 Usage
|
|
28851
|
+
|
|
28852
|
+
<dl>
|
|
28853
|
+
<dd>
|
|
28854
|
+
|
|
28855
|
+
<dl>
|
|
28856
|
+
<dd>
|
|
28857
|
+
|
|
28858
|
+
```ruby
|
|
28859
|
+
client.case_management.list_transitions(uuid: "9c2b7e14-3a5f-4d21-b8e0-1f6a4c9d2e70")
|
|
28860
|
+
```
|
|
28861
|
+
</dd>
|
|
28862
|
+
</dl>
|
|
28863
|
+
</dd>
|
|
28864
|
+
</dl>
|
|
28865
|
+
|
|
28866
|
+
#### ⚙️ Parameters
|
|
28867
|
+
|
|
28868
|
+
<dl>
|
|
28869
|
+
<dd>
|
|
28870
|
+
|
|
28871
|
+
<dl>
|
|
28872
|
+
<dd>
|
|
28873
|
+
|
|
28874
|
+
**uuid:** `String` — The case's UUID.
|
|
28875
|
+
|
|
28876
|
+
</dd>
|
|
28877
|
+
</dl>
|
|
28878
|
+
|
|
28879
|
+
<dl>
|
|
28880
|
+
<dd>
|
|
28881
|
+
|
|
28882
|
+
**request_options:** `Payabli::CaseManagement::RequestOptions`
|
|
28883
|
+
|
|
28884
|
+
</dd>
|
|
28885
|
+
</dl>
|
|
28886
|
+
</dd>
|
|
28887
|
+
</dl>
|
|
28888
|
+
|
|
28889
|
+
|
|
28890
|
+
</dd>
|
|
28891
|
+
</dl>
|
|
28892
|
+
</details>
|
|
28893
|
+
|
|
28894
|
+
<details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">transition</a>(uuid:, request) -> Payabli::Types::CaseResponse</code></summary>
|
|
28895
|
+
<dl>
|
|
28896
|
+
<dd>
|
|
28897
|
+
|
|
28898
|
+
#### 📝 Description
|
|
28899
|
+
|
|
28900
|
+
<dl>
|
|
28901
|
+
<dd>
|
|
28902
|
+
|
|
28903
|
+
<dl>
|
|
28904
|
+
<dd>
|
|
28905
|
+
|
|
28906
|
+
Fires a review action on a case, such as `Approve`, `Deny`, `Escalate`,
|
|
28907
|
+
or `RequestReview`. Assigning a case uses the dedicated assign endpoint,
|
|
28908
|
+
not this one. Firing an action that isn't valid for the case's current
|
|
28909
|
+
state returns `409`.
|
|
28910
|
+
|
|
28911
|
+
Available to Enterprise Partners only.
|
|
28912
|
+
</dd>
|
|
28913
|
+
</dl>
|
|
28914
|
+
</dd>
|
|
28915
|
+
</dl>
|
|
28916
|
+
|
|
28917
|
+
#### 🔌 Usage
|
|
28918
|
+
|
|
28919
|
+
<dl>
|
|
28920
|
+
<dd>
|
|
28921
|
+
|
|
28922
|
+
<dl>
|
|
28923
|
+
<dd>
|
|
28924
|
+
|
|
28925
|
+
```ruby
|
|
28926
|
+
client.case_management.transition(
|
|
28927
|
+
uuid: "9c2b7e14-3a5f-4d21-b8e0-1f6a4c9d2e70",
|
|
28928
|
+
trigger: "Approve",
|
|
28929
|
+
reason: "Account ownership confirmed with the merchant by phone."
|
|
28930
|
+
)
|
|
28931
|
+
```
|
|
28932
|
+
</dd>
|
|
28933
|
+
</dl>
|
|
28934
|
+
</dd>
|
|
28935
|
+
</dl>
|
|
28936
|
+
|
|
28937
|
+
#### ⚙️ Parameters
|
|
28938
|
+
|
|
28939
|
+
<dl>
|
|
28940
|
+
<dd>
|
|
28941
|
+
|
|
28942
|
+
<dl>
|
|
28943
|
+
<dd>
|
|
28944
|
+
|
|
28945
|
+
**uuid:** `String` — The case's UUID.
|
|
28946
|
+
|
|
28947
|
+
</dd>
|
|
28948
|
+
</dl>
|
|
28949
|
+
|
|
28950
|
+
<dl>
|
|
28951
|
+
<dd>
|
|
28952
|
+
|
|
28953
|
+
**trigger:** `Payabli::Types::CaseTrigger`
|
|
28954
|
+
|
|
28955
|
+
</dd>
|
|
28956
|
+
</dl>
|
|
28957
|
+
|
|
28958
|
+
<dl>
|
|
28959
|
+
<dd>
|
|
28960
|
+
|
|
28961
|
+
**reason:** `String` — The reason for the action.
|
|
28962
|
+
|
|
28963
|
+
</dd>
|
|
28964
|
+
</dl>
|
|
28965
|
+
|
|
28966
|
+
<dl>
|
|
28967
|
+
<dd>
|
|
28968
|
+
|
|
28969
|
+
**decline_reason:** `Payabli::Types::BankReviewDecisionReason` — The decline reason. Required when the trigger is `Deny`, and must be omitted otherwise.
|
|
28970
|
+
|
|
28971
|
+
</dd>
|
|
28972
|
+
</dl>
|
|
28973
|
+
|
|
28974
|
+
<dl>
|
|
28975
|
+
<dd>
|
|
28976
|
+
|
|
28977
|
+
**request_options:** `Payabli::CaseManagement::RequestOptions`
|
|
28978
|
+
|
|
28979
|
+
</dd>
|
|
28980
|
+
</dl>
|
|
28981
|
+
</dd>
|
|
28982
|
+
</dl>
|
|
28983
|
+
|
|
28984
|
+
|
|
28985
|
+
</dd>
|
|
28986
|
+
</dl>
|
|
28987
|
+
</details>
|
|
28988
|
+
|
|
28989
|
+
<details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">assign_case</a>(uuid:, request) -> Payabli::Types::CaseResponse</code></summary>
|
|
28990
|
+
<dl>
|
|
28991
|
+
<dd>
|
|
28992
|
+
|
|
28993
|
+
#### 📝 Description
|
|
28994
|
+
|
|
28995
|
+
<dl>
|
|
28996
|
+
<dd>
|
|
28997
|
+
|
|
28998
|
+
<dl>
|
|
28999
|
+
<dd>
|
|
29000
|
+
|
|
29001
|
+
Assigns a case to a reviewer.
|
|
29002
|
+
|
|
29003
|
+
Available to Enterprise Partners only.
|
|
29004
|
+
</dd>
|
|
29005
|
+
</dl>
|
|
29006
|
+
</dd>
|
|
29007
|
+
</dl>
|
|
29008
|
+
|
|
29009
|
+
#### 🔌 Usage
|
|
29010
|
+
|
|
29011
|
+
<dl>
|
|
29012
|
+
<dd>
|
|
29013
|
+
|
|
29014
|
+
<dl>
|
|
29015
|
+
<dd>
|
|
29016
|
+
|
|
29017
|
+
```ruby
|
|
29018
|
+
client.case_management.assign_case(
|
|
29019
|
+
uuid: "9c2b7e14-3a5f-4d21-b8e0-1f6a4c9d2e70",
|
|
29020
|
+
assignee_id: 4238,
|
|
29021
|
+
reason: "Routing to the risk team for review."
|
|
29022
|
+
)
|
|
29023
|
+
```
|
|
29024
|
+
</dd>
|
|
29025
|
+
</dl>
|
|
29026
|
+
</dd>
|
|
29027
|
+
</dl>
|
|
29028
|
+
|
|
29029
|
+
#### ⚙️ Parameters
|
|
29030
|
+
|
|
29031
|
+
<dl>
|
|
29032
|
+
<dd>
|
|
29033
|
+
|
|
29034
|
+
<dl>
|
|
29035
|
+
<dd>
|
|
29036
|
+
|
|
29037
|
+
**uuid:** `String` — The case's UUID.
|
|
29038
|
+
|
|
29039
|
+
</dd>
|
|
29040
|
+
</dl>
|
|
29041
|
+
|
|
29042
|
+
<dl>
|
|
29043
|
+
<dd>
|
|
29044
|
+
|
|
29045
|
+
**assignee_id:** `Integer` — The numeric id of the reviewer to assign the case to.
|
|
29046
|
+
|
|
29047
|
+
</dd>
|
|
29048
|
+
</dl>
|
|
29049
|
+
|
|
29050
|
+
<dl>
|
|
29051
|
+
<dd>
|
|
29052
|
+
|
|
29053
|
+
**reason:** `String` — An optional reason for the assignment.
|
|
29054
|
+
|
|
29055
|
+
</dd>
|
|
29056
|
+
</dl>
|
|
29057
|
+
|
|
29058
|
+
<dl>
|
|
29059
|
+
<dd>
|
|
29060
|
+
|
|
29061
|
+
**request_options:** `Payabli::CaseManagement::RequestOptions`
|
|
29062
|
+
|
|
29063
|
+
</dd>
|
|
29064
|
+
</dl>
|
|
29065
|
+
</dd>
|
|
29066
|
+
</dl>
|
|
29067
|
+
|
|
29068
|
+
|
|
29069
|
+
</dd>
|
|
29070
|
+
</dl>
|
|
29071
|
+
</details>
|
|
29072
|
+
|
|
29073
|
+
<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>
|
|
29074
|
+
<dl>
|
|
29075
|
+
<dd>
|
|
29076
|
+
|
|
29077
|
+
#### 📝 Description
|
|
29078
|
+
|
|
29079
|
+
<dl>
|
|
29080
|
+
<dd>
|
|
29081
|
+
|
|
29082
|
+
<dl>
|
|
29083
|
+
<dd>
|
|
29084
|
+
|
|
29085
|
+
Lists the files attached to a case.
|
|
29086
|
+
|
|
29087
|
+
Available to both Platform and Enterprise Partners.
|
|
29088
|
+
</dd>
|
|
29089
|
+
</dl>
|
|
29090
|
+
</dd>
|
|
29091
|
+
</dl>
|
|
29092
|
+
|
|
29093
|
+
#### 🔌 Usage
|
|
29094
|
+
|
|
29095
|
+
<dl>
|
|
29096
|
+
<dd>
|
|
29097
|
+
|
|
29098
|
+
<dl>
|
|
29099
|
+
<dd>
|
|
29100
|
+
|
|
29101
|
+
```ruby
|
|
29102
|
+
client.case_management.list_attachments(case_uuid: "9c2b7e14-3a5f-4d21-b8e0-1f6a4c9d2e70")
|
|
29103
|
+
```
|
|
29104
|
+
</dd>
|
|
29105
|
+
</dl>
|
|
29106
|
+
</dd>
|
|
29107
|
+
</dl>
|
|
29108
|
+
|
|
29109
|
+
#### ⚙️ Parameters
|
|
29110
|
+
|
|
29111
|
+
<dl>
|
|
29112
|
+
<dd>
|
|
29113
|
+
|
|
29114
|
+
<dl>
|
|
29115
|
+
<dd>
|
|
29116
|
+
|
|
29117
|
+
**case_uuid:** `String` — The case's UUID.
|
|
29118
|
+
|
|
29119
|
+
</dd>
|
|
29120
|
+
</dl>
|
|
29121
|
+
|
|
29122
|
+
<dl>
|
|
29123
|
+
<dd>
|
|
29124
|
+
|
|
29125
|
+
**request_options:** `Payabli::CaseManagement::RequestOptions`
|
|
29126
|
+
|
|
29127
|
+
</dd>
|
|
29128
|
+
</dl>
|
|
29129
|
+
</dd>
|
|
29130
|
+
</dl>
|
|
29131
|
+
|
|
29132
|
+
|
|
29133
|
+
</dd>
|
|
29134
|
+
</dl>
|
|
29135
|
+
</details>
|
|
29136
|
+
|
|
29137
|
+
<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>
|
|
29138
|
+
<dl>
|
|
29139
|
+
<dd>
|
|
29140
|
+
|
|
29141
|
+
#### 📝 Description
|
|
29142
|
+
|
|
29143
|
+
<dl>
|
|
29144
|
+
<dd>
|
|
29145
|
+
|
|
29146
|
+
<dl>
|
|
29147
|
+
<dd>
|
|
29148
|
+
|
|
29149
|
+
Uploads a file to a case as multipart form data. The maximum size is
|
|
29150
|
+
25 MiB, and the content type must be an allowed type such as PDF, PNG,
|
|
29151
|
+
JPEG, CSV, XLSX, DOCX, or plain text.
|
|
29152
|
+
|
|
29153
|
+
Available to both Platform and Enterprise Partners.
|
|
29154
|
+
</dd>
|
|
29155
|
+
</dl>
|
|
29156
|
+
</dd>
|
|
29157
|
+
</dl>
|
|
29158
|
+
|
|
29159
|
+
#### 🔌 Usage
|
|
29160
|
+
|
|
29161
|
+
<dl>
|
|
29162
|
+
<dd>
|
|
29163
|
+
|
|
29164
|
+
<dl>
|
|
29165
|
+
<dd>
|
|
29166
|
+
|
|
29167
|
+
```ruby
|
|
29168
|
+
client.case_management.upload_attachment(case_uuid: "caseUuid")
|
|
29169
|
+
```
|
|
29170
|
+
</dd>
|
|
29171
|
+
</dl>
|
|
29172
|
+
</dd>
|
|
29173
|
+
</dl>
|
|
29174
|
+
|
|
29175
|
+
#### ⚙️ Parameters
|
|
29176
|
+
|
|
29177
|
+
<dl>
|
|
29178
|
+
<dd>
|
|
29179
|
+
|
|
29180
|
+
<dl>
|
|
29181
|
+
<dd>
|
|
29182
|
+
|
|
29183
|
+
**case_uuid:** `String` — The case's UUID.
|
|
29184
|
+
|
|
29185
|
+
</dd>
|
|
29186
|
+
</dl>
|
|
29187
|
+
|
|
29188
|
+
<dl>
|
|
29189
|
+
<dd>
|
|
29190
|
+
|
|
29191
|
+
**request_options:** `Payabli::CaseManagement::RequestOptions`
|
|
29192
|
+
|
|
29193
|
+
</dd>
|
|
29194
|
+
</dl>
|
|
29195
|
+
</dd>
|
|
29196
|
+
</dl>
|
|
29197
|
+
|
|
29198
|
+
|
|
29199
|
+
</dd>
|
|
29200
|
+
</dl>
|
|
29201
|
+
</details>
|
|
29202
|
+
|
|
29203
|
+
<details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">get_attachment</a>(case_uuid:, attachment_id:) -> String</code></summary>
|
|
29204
|
+
<dl>
|
|
29205
|
+
<dd>
|
|
29206
|
+
|
|
29207
|
+
#### 📝 Description
|
|
29208
|
+
|
|
29209
|
+
<dl>
|
|
29210
|
+
<dd>
|
|
29211
|
+
|
|
29212
|
+
<dl>
|
|
29213
|
+
<dd>
|
|
29214
|
+
|
|
29215
|
+
Streams the file content of an attachment.
|
|
29216
|
+
|
|
29217
|
+
Available to both Platform and Enterprise Partners.
|
|
29218
|
+
</dd>
|
|
29219
|
+
</dl>
|
|
29220
|
+
</dd>
|
|
29221
|
+
</dl>
|
|
29222
|
+
|
|
29223
|
+
#### 🔌 Usage
|
|
29224
|
+
|
|
29225
|
+
<dl>
|
|
29226
|
+
<dd>
|
|
29227
|
+
|
|
29228
|
+
<dl>
|
|
29229
|
+
<dd>
|
|
29230
|
+
|
|
29231
|
+
```ruby
|
|
29232
|
+
client.case_management.get_attachment(
|
|
29233
|
+
case_uuid: "caseUuid",
|
|
29234
|
+
attachment_id: "attachmentId"
|
|
29235
|
+
)
|
|
29236
|
+
```
|
|
29237
|
+
</dd>
|
|
29238
|
+
</dl>
|
|
29239
|
+
</dd>
|
|
29240
|
+
</dl>
|
|
29241
|
+
|
|
29242
|
+
#### ⚙️ Parameters
|
|
29243
|
+
|
|
29244
|
+
<dl>
|
|
29245
|
+
<dd>
|
|
29246
|
+
|
|
29247
|
+
<dl>
|
|
29248
|
+
<dd>
|
|
29249
|
+
|
|
29250
|
+
**case_uuid:** `String` — The case's UUID.
|
|
29251
|
+
|
|
29252
|
+
</dd>
|
|
29253
|
+
</dl>
|
|
29254
|
+
|
|
29255
|
+
<dl>
|
|
29256
|
+
<dd>
|
|
29257
|
+
|
|
29258
|
+
**attachment_id:** `String` — The attachment's UUID.
|
|
29259
|
+
|
|
29260
|
+
</dd>
|
|
29261
|
+
</dl>
|
|
29262
|
+
|
|
29263
|
+
<dl>
|
|
29264
|
+
<dd>
|
|
29265
|
+
|
|
29266
|
+
**request_options:** `Payabli::CaseManagement::RequestOptions`
|
|
29267
|
+
|
|
29268
|
+
</dd>
|
|
29269
|
+
</dl>
|
|
29270
|
+
</dd>
|
|
29271
|
+
</dl>
|
|
29272
|
+
|
|
29273
|
+
|
|
29274
|
+
</dd>
|
|
29275
|
+
</dl>
|
|
29276
|
+
</details>
|
|
29277
|
+
|
|
29278
|
+
<details><summary><code>client.case_management.<a href="/lib/payabli/case_management/client.rb">delete_attachment</a>(case_uuid:, attachment_id:) -> </code></summary>
|
|
29279
|
+
<dl>
|
|
29280
|
+
<dd>
|
|
29281
|
+
|
|
29282
|
+
#### 📝 Description
|
|
29283
|
+
|
|
29284
|
+
<dl>
|
|
29285
|
+
<dd>
|
|
29286
|
+
|
|
29287
|
+
<dl>
|
|
29288
|
+
<dd>
|
|
29289
|
+
|
|
29290
|
+
Deletes an attachment from a case.
|
|
29291
|
+
|
|
29292
|
+
Available to both Platform and Enterprise Partners.
|
|
29293
|
+
</dd>
|
|
29294
|
+
</dl>
|
|
29295
|
+
</dd>
|
|
29296
|
+
</dl>
|
|
29297
|
+
|
|
29298
|
+
#### 🔌 Usage
|
|
29299
|
+
|
|
29300
|
+
<dl>
|
|
29301
|
+
<dd>
|
|
29302
|
+
|
|
29303
|
+
<dl>
|
|
29304
|
+
<dd>
|
|
29305
|
+
|
|
29306
|
+
```ruby
|
|
29307
|
+
client.case_management.delete_attachment(
|
|
29308
|
+
case_uuid: "caseUuid",
|
|
29309
|
+
attachment_id: "attachmentId"
|
|
29310
|
+
)
|
|
29311
|
+
```
|
|
29312
|
+
</dd>
|
|
29313
|
+
</dl>
|
|
29314
|
+
</dd>
|
|
29315
|
+
</dl>
|
|
29316
|
+
|
|
29317
|
+
#### ⚙️ Parameters
|
|
29318
|
+
|
|
29319
|
+
<dl>
|
|
29320
|
+
<dd>
|
|
29321
|
+
|
|
29322
|
+
<dl>
|
|
29323
|
+
<dd>
|
|
29324
|
+
|
|
29325
|
+
**case_uuid:** `String` — The case's UUID.
|
|
29326
|
+
|
|
29327
|
+
</dd>
|
|
29328
|
+
</dl>
|
|
29329
|
+
|
|
29330
|
+
<dl>
|
|
29331
|
+
<dd>
|
|
29332
|
+
|
|
29333
|
+
**attachment_id:** `String` — The attachment's UUID.
|
|
29334
|
+
|
|
29335
|
+
</dd>
|
|
29336
|
+
</dl>
|
|
29337
|
+
|
|
29338
|
+
<dl>
|
|
29339
|
+
<dd>
|
|
29340
|
+
|
|
29341
|
+
**request_options:** `Payabli::CaseManagement::RequestOptions`
|
|
29342
|
+
|
|
29343
|
+
</dd>
|
|
29344
|
+
</dl>
|
|
29345
|
+
</dd>
|
|
29346
|
+
</dl>
|
|
29347
|
+
|
|
29348
|
+
|
|
29349
|
+
</dd>
|
|
29350
|
+
</dl>
|
|
29351
|
+
</details>
|
|
29352
|
+
|
|
29353
|
+
## Billing
|
|
29354
|
+
<details><summary><code>client.billing.<a href="/lib/payabli/billing/client.rb">list_profiles</a>(org_id:) -> Payabli::Types::BillingProfileQueryResponse</code></summary>
|
|
29355
|
+
<dl>
|
|
29356
|
+
<dd>
|
|
29357
|
+
|
|
29358
|
+
#### 📝 Description
|
|
29359
|
+
|
|
29360
|
+
<dl>
|
|
29361
|
+
<dd>
|
|
29362
|
+
|
|
29363
|
+
<dl>
|
|
29364
|
+
<dd>
|
|
29365
|
+
|
|
29366
|
+
Returns every billing profile that belongs to an organization. This is
|
|
29367
|
+
the data behind the Profile Library table in the Payabli Portal.
|
|
29368
|
+
|
|
29369
|
+
Requires a token with the `billing_profile_read` permission; a token
|
|
29370
|
+
without it gets `403 Forbidden`.
|
|
29371
|
+
</dd>
|
|
29372
|
+
</dl>
|
|
29373
|
+
</dd>
|
|
29374
|
+
</dl>
|
|
29375
|
+
|
|
29376
|
+
#### 🔌 Usage
|
|
29377
|
+
|
|
29378
|
+
<dl>
|
|
29379
|
+
<dd>
|
|
29380
|
+
|
|
29381
|
+
<dl>
|
|
29382
|
+
<dd>
|
|
29383
|
+
|
|
29384
|
+
```ruby
|
|
29385
|
+
client.billing.list_profiles(
|
|
29386
|
+
org_id: 123,
|
|
29387
|
+
limit_record: 20,
|
|
29388
|
+
from_record: 0
|
|
29389
|
+
)
|
|
29390
|
+
```
|
|
29391
|
+
</dd>
|
|
29392
|
+
</dl>
|
|
29393
|
+
</dd>
|
|
29394
|
+
</dl>
|
|
29395
|
+
|
|
29396
|
+
#### ⚙️ Parameters
|
|
29397
|
+
|
|
29398
|
+
<dl>
|
|
29399
|
+
<dd>
|
|
29400
|
+
|
|
29401
|
+
<dl>
|
|
29402
|
+
<dd>
|
|
29403
|
+
|
|
29404
|
+
**org_id:** `Integer` — The organization's numeric identifier.
|
|
29405
|
+
|
|
29406
|
+
</dd>
|
|
29407
|
+
</dl>
|
|
29408
|
+
|
|
29409
|
+
<dl>
|
|
29410
|
+
<dd>
|
|
29411
|
+
|
|
29412
|
+
**profile_name:** `String` — Filter to profiles whose name contains this string.
|
|
29413
|
+
|
|
29414
|
+
</dd>
|
|
29415
|
+
</dl>
|
|
29416
|
+
|
|
29417
|
+
<dl>
|
|
29418
|
+
<dd>
|
|
29419
|
+
|
|
29420
|
+
**fee_type:** `Integer`
|
|
29421
|
+
|
|
29422
|
+
Filter by fee type. Repeatable to match more than one. Send the enum
|
|
29423
|
+
value (`1` Flat, `2` ICP).
|
|
29424
|
+
|
|
29425
|
+
</dd>
|
|
29426
|
+
</dl>
|
|
29427
|
+
|
|
29428
|
+
<dl>
|
|
29429
|
+
<dd>
|
|
29430
|
+
|
|
29431
|
+
**service_vertical:** `Integer`
|
|
29432
|
+
|
|
29433
|
+
Filter by billing vertical. Repeatable to match more than one. Send
|
|
29434
|
+
the enum value (`1` PayIn, `2` PayOut, `3` PayOps).
|
|
29435
|
+
|
|
29436
|
+
</dd>
|
|
29437
|
+
</dl>
|
|
29438
|
+
|
|
29439
|
+
<dl>
|
|
29440
|
+
<dd>
|
|
29441
|
+
|
|
29442
|
+
**profile_id:** `Integer` — Filter to a single profile by its identifier.
|
|
29443
|
+
|
|
29444
|
+
</dd>
|
|
29445
|
+
</dl>
|
|
29446
|
+
|
|
29447
|
+
<dl>
|
|
29448
|
+
<dd>
|
|
29449
|
+
|
|
29450
|
+
**limit_record:** `Integer`
|
|
29451
|
+
|
|
29452
|
+
Page size. Defaults to `20`. Passing `0` returns no records — use a
|
|
29453
|
+
positive value to page through results.
|
|
29454
|
+
|
|
29455
|
+
</dd>
|
|
29456
|
+
</dl>
|
|
29457
|
+
|
|
29458
|
+
<dl>
|
|
29459
|
+
<dd>
|
|
29460
|
+
|
|
29461
|
+
**from_record:** `Integer` — Zero-based offset into the result set. Defaults to `0`.
|
|
29462
|
+
|
|
29463
|
+
</dd>
|
|
29464
|
+
</dl>
|
|
29465
|
+
|
|
29466
|
+
<dl>
|
|
29467
|
+
<dd>
|
|
29468
|
+
|
|
29469
|
+
**request_options:** `Payabli::Billing::RequestOptions`
|
|
29470
|
+
|
|
29471
|
+
</dd>
|
|
29472
|
+
</dl>
|
|
29473
|
+
</dd>
|
|
29474
|
+
</dl>
|
|
29475
|
+
|
|
29476
|
+
|
|
29477
|
+
</dd>
|
|
29478
|
+
</dl>
|
|
29479
|
+
</details>
|
|
29480
|
+
|
|
29481
|
+
<details><summary><code>client.billing.<a href="/lib/payabli/billing/client.rb">get_profile</a>(service_group:, entity_type:, entity_id:) -> Payabli::Types::BillingProfileResponse</code></summary>
|
|
29482
|
+
<dl>
|
|
29483
|
+
<dd>
|
|
29484
|
+
|
|
29485
|
+
#### 📝 Description
|
|
29486
|
+
|
|
29487
|
+
<dl>
|
|
29488
|
+
<dd>
|
|
29489
|
+
|
|
29490
|
+
<dl>
|
|
29491
|
+
<dd>
|
|
29492
|
+
|
|
29493
|
+
Returns the billing profile currently assigned to an entity, including
|
|
29494
|
+
its billable events and fee schedules. Use it to read the pricing terms
|
|
29495
|
+
in effect for an organization, paypoint, template, or application.
|
|
29496
|
+
|
|
29497
|
+
Requires a token with the `billing_profile_read` permission and access
|
|
29498
|
+
to the requested entity; otherwise the call gets `403 Forbidden`.
|
|
29499
|
+
|
|
29500
|
+
If the entity exists but has no profile assigned, the call returns
|
|
29501
|
+
`404 Not Found`.
|
|
29502
|
+
</dd>
|
|
29503
|
+
</dl>
|
|
29504
|
+
</dd>
|
|
29505
|
+
</dl>
|
|
29506
|
+
|
|
29507
|
+
#### 🔌 Usage
|
|
29508
|
+
|
|
29509
|
+
<dl>
|
|
29510
|
+
<dd>
|
|
29511
|
+
|
|
29512
|
+
<dl>
|
|
29513
|
+
<dd>
|
|
29514
|
+
|
|
29515
|
+
```ruby
|
|
29516
|
+
client.billing.get_profile(
|
|
29517
|
+
service_group: "PayIn",
|
|
29518
|
+
entity_type: "Organization",
|
|
29519
|
+
entity_id: 123
|
|
29520
|
+
)
|
|
29521
|
+
```
|
|
29522
|
+
</dd>
|
|
29523
|
+
</dl>
|
|
29524
|
+
</dd>
|
|
29525
|
+
</dl>
|
|
29526
|
+
|
|
29527
|
+
#### ⚙️ Parameters
|
|
29528
|
+
|
|
29529
|
+
<dl>
|
|
29530
|
+
<dd>
|
|
29531
|
+
|
|
29532
|
+
<dl>
|
|
29533
|
+
<dd>
|
|
29534
|
+
|
|
29535
|
+
**service_group:** `Payabli::Billing::Types::GetProfileBillingRequestServiceGroup`
|
|
29536
|
+
|
|
29537
|
+
The billing vertical. Only `PayIn` and `PayOut` are accepted; any
|
|
29538
|
+
other value returns `400 Bad Request`.
|
|
29539
|
+
|
|
29540
|
+
</dd>
|
|
29541
|
+
</dl>
|
|
29542
|
+
|
|
29543
|
+
<dl>
|
|
29544
|
+
<dd>
|
|
29545
|
+
|
|
29546
|
+
**entity_type:** `Payabli::Billing::Types::GetProfileBillingRequestEntityType`
|
|
29547
|
+
|
|
29548
|
+
The owning entity type: `Organization`, `Paypoint`, `Template`, or
|
|
29549
|
+
`Application`.
|
|
29550
|
+
|
|
29551
|
+
</dd>
|
|
29552
|
+
</dl>
|
|
29553
|
+
|
|
29554
|
+
<dl>
|
|
29555
|
+
<dd>
|
|
29556
|
+
|
|
29557
|
+
**entity_id:** `Integer` — The numeric identifier of the entity.
|
|
29558
|
+
|
|
29559
|
+
</dd>
|
|
29560
|
+
</dl>
|
|
29561
|
+
|
|
29562
|
+
<dl>
|
|
29563
|
+
<dd>
|
|
29564
|
+
|
|
29565
|
+
**request_options:** `Payabli::Billing::RequestOptions`
|
|
29566
|
+
|
|
29567
|
+
</dd>
|
|
29568
|
+
</dl>
|
|
29569
|
+
</dd>
|
|
29570
|
+
</dl>
|
|
29571
|
+
|
|
29572
|
+
|
|
29573
|
+
</dd>
|
|
29574
|
+
</dl>
|
|
29575
|
+
</details>
|
|
29576
|
+
|