payabli 3.0.7 → 3.0.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.fern/metadata.json +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/client.rb +11 -1
- data/lib/payabli/cloud/client.rb +2 -2
- data/lib/payabli/customer/client.rb +4 -1
- data/lib/payabli/device/client.rb +63 -0
- data/lib/payabli/funding/client.rb +1 -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 +71 -64
- data/lib/payabli/money_out/client.rb +2 -4
- data/lib/payabli/money_out/types/request_out_authorize.rb +1 -3
- data/lib/payabli/notification/client.rb +8 -5
- 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/auth_capture_payout_response_data.rb +1 -1
- 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/collection_schedule_value.rb +23 -0
- data/lib/payabli/types/device_challenge_data.rb +12 -0
- data/lib/payabli/types/device_challenge_response.rb +21 -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/{lot_number.rb → fee_type_value.rb} +2 -2
- data/lib/payabli/types/methodall.rb +1 -0
- data/lib/payabli/types/operation_result.rb +4 -2
- data/lib/payabli/types/passthrough_value.rb +23 -0
- data/lib/payabli/types/pay_method_cloud.rb +0 -2
- data/lib/payabli/types/pay_method_device.rb +14 -0
- data/lib/payabli/types/pay_method_device_method.rb +11 -0
- data/lib/payabli/types/payment_method.rb +2 -0
- data/lib/payabli/types/paypoint_data.rb +2 -0
- data/lib/payabli/types/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/request_out_authorize_invoice_data.rb +4 -25
- data/lib/payabli/types/request_out_authorize_vendor_data.rb +3 -61
- 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/transaction_detail_payment_data.rb +2 -2
- data/lib/payabli/types/v_2_transaction_detail_response_data.rb +1 -1
- data/lib/payabli/types/v_2_transaction_details.rb +1 -1
- data/lib/payabli/user/client.rb +8 -2
- data/lib/payabli/vendor/client.rb +8 -2
- data/lib/payabli/version.rb +1 -1
- data/lib/payabli.rb +33 -2
- data/reference.md +690 -531
- data/wiremock/wiremock-mappings.json +172 -65
- metadata +35 -4
- data/lib/payabli/types/request_out_authorize_vendor_billing_data.rb +0 -19
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>
|
|
@@ -1603,22 +1599,12 @@ Only card transactions can be authorized. This endpoint can't be used for ACH tr
|
|
|
1603
1599
|
|
|
1604
1600
|
```ruby
|
|
1605
1601
|
client.money_in.authorize(
|
|
1606
|
-
customer_data: {
|
|
1607
|
-
customer_id: 4440
|
|
1608
|
-
},
|
|
1609
|
-
entry_point: "8cfec329267",
|
|
1610
|
-
ipaddress: "255.255.255.255",
|
|
1611
1602
|
payment_details: {
|
|
1612
|
-
|
|
1613
|
-
total_amount: 100
|
|
1603
|
+
total_amount: 1.1
|
|
1614
1604
|
},
|
|
1615
1605
|
payment_method: {
|
|
1616
|
-
|
|
1617
|
-
|
|
1618
|
-
card_holder: "John Cassian",
|
|
1619
|
-
cardnumber: "4111111111111111",
|
|
1620
|
-
cardzip: "12345",
|
|
1621
|
-
initiator: "payor",
|
|
1606
|
+
cardexp: "cardexp",
|
|
1607
|
+
cardnumber: "cardnumber",
|
|
1622
1608
|
method_: "card"
|
|
1623
1609
|
}
|
|
1624
1610
|
)
|
|
@@ -1705,8 +1691,8 @@ transaction](/developers/api-reference/moneyin/authorize-a-transaction) to compl
|
|
|
1705
1691
|
|
|
1706
1692
|
```ruby
|
|
1707
1693
|
client.money_in.capture(
|
|
1708
|
-
trans_id: "
|
|
1709
|
-
amount:
|
|
1694
|
+
trans_id: "transId",
|
|
1695
|
+
amount: 1.1
|
|
1710
1696
|
)
|
|
1711
1697
|
```
|
|
1712
1698
|
</dd>
|
|
@@ -1784,10 +1770,9 @@ You can use this endpoint to capture both full and partial amounts of the origin
|
|
|
1784
1770
|
|
|
1785
1771
|
```ruby
|
|
1786
1772
|
client.money_in.capture_auth(
|
|
1787
|
-
trans_id: "
|
|
1773
|
+
trans_id: "transId",
|
|
1788
1774
|
payment_details: {
|
|
1789
|
-
total_amount:
|
|
1790
|
-
service_fee: 5
|
|
1775
|
+
total_amount: 1.1
|
|
1791
1776
|
}
|
|
1792
1777
|
)
|
|
1793
1778
|
```
|
|
@@ -2088,22 +2073,12 @@ Make a single transaction. This method authorizes and captures a payment in one
|
|
|
2088
2073
|
|
|
2089
2074
|
```ruby
|
|
2090
2075
|
client.money_in.getpaid(
|
|
2091
|
-
customer_data: {
|
|
2092
|
-
customer_id: 4440
|
|
2093
|
-
},
|
|
2094
|
-
entry_point: "8cfec329267",
|
|
2095
|
-
ipaddress: "255.255.255.255",
|
|
2096
2076
|
payment_details: {
|
|
2097
|
-
|
|
2098
|
-
total_amount: 100
|
|
2077
|
+
total_amount: 1.1
|
|
2099
2078
|
},
|
|
2100
2079
|
payment_method: {
|
|
2101
|
-
|
|
2102
|
-
|
|
2103
|
-
card_holder: "John Cassian",
|
|
2104
|
-
cardnumber: "4111111111111111",
|
|
2105
|
-
cardzip: "12345",
|
|
2106
|
-
initiator: "payor",
|
|
2080
|
+
cardexp: "cardexp",
|
|
2081
|
+
cardnumber: "cardnumber",
|
|
2107
2082
|
method_: "card"
|
|
2108
2083
|
}
|
|
2109
2084
|
)
|
|
@@ -2213,8 +2188,8 @@ A reversal either refunds or voids a transaction independent of the transaction'
|
|
|
2213
2188
|
|
|
2214
2189
|
```ruby
|
|
2215
2190
|
client.money_in.reverse(
|
|
2216
|
-
trans_id: "
|
|
2217
|
-
amount:
|
|
2191
|
+
trans_id: "transId",
|
|
2192
|
+
amount: 1.1
|
|
2218
2193
|
)
|
|
2219
2194
|
```
|
|
2220
2195
|
</dd>
|
|
@@ -2296,8 +2271,8 @@ Refund a transaction that has settled and send money back to the account holder.
|
|
|
2296
2271
|
|
|
2297
2272
|
```ruby
|
|
2298
2273
|
client.money_in.refund(
|
|
2299
|
-
trans_id: "
|
|
2300
|
-
amount:
|
|
2274
|
+
trans_id: "transId",
|
|
2275
|
+
amount: 1.1
|
|
2301
2276
|
)
|
|
2302
2277
|
```
|
|
2303
2278
|
</dd>
|
|
@@ -2378,26 +2353,7 @@ Refunds a settled transaction with split instructions.
|
|
|
2378
2353
|
<dd>
|
|
2379
2354
|
|
|
2380
2355
|
```ruby
|
|
2381
|
-
client.money_in.refund_with_instructions(
|
|
2382
|
-
trans_id: "10-3ffa27df-b171-44e0-b251-e95fbfc7a723",
|
|
2383
|
-
idempotency_key: "8A29FC40-CA47-1067-B31D-00DD010662DB",
|
|
2384
|
-
amount: 100,
|
|
2385
|
-
order_description: "Materials deposit",
|
|
2386
|
-
refund_details: {
|
|
2387
|
-
split_refunding: [{
|
|
2388
|
-
origination_entry_point: "7f1a381696",
|
|
2389
|
-
account_id: "187-342",
|
|
2390
|
-
description: "Refunding undelivered materials",
|
|
2391
|
-
amount: 60
|
|
2392
|
-
}, {
|
|
2393
|
-
origination_entry_point: "7f1a381696",
|
|
2394
|
-
account_id: "187-343",
|
|
2395
|
-
description: "Refunding deposit for undelivered materials",
|
|
2396
|
-
amount: 40
|
|
2397
|
-
}]
|
|
2398
|
-
},
|
|
2399
|
-
source: "api"
|
|
2400
|
-
)
|
|
2356
|
+
client.money_in.refund_with_instructions(trans_id: "transId")
|
|
2401
2357
|
```
|
|
2402
2358
|
</dd>
|
|
2403
2359
|
</dl>
|
|
@@ -2776,7 +2732,7 @@ Cancel a transaction that hasn't been settled yet. Voiding non-captured authoriz
|
|
|
2776
2732
|
<dd>
|
|
2777
2733
|
|
|
2778
2734
|
```ruby
|
|
2779
|
-
client.money_in.void(trans_id: "
|
|
2735
|
+
client.money_in.void(trans_id: "transId")
|
|
2780
2736
|
```
|
|
2781
2737
|
</dd>
|
|
2782
2738
|
</dl>
|
|
@@ -3132,7 +3088,25 @@ This is the v2 version of the refund endpoint, and returns the unified response
|
|
|
3132
3088
|
<dd>
|
|
3133
3089
|
|
|
3134
3090
|
```ruby
|
|
3135
|
-
client.money_in.refundv_2(
|
|
3091
|
+
client.money_in.refundv_2(
|
|
3092
|
+
trans_id: "10-3ffa27df-b171-44e0-b251-e95fbfc7a723",
|
|
3093
|
+
amount: 100,
|
|
3094
|
+
order_description: "Materials deposit",
|
|
3095
|
+
refund_details: {
|
|
3096
|
+
split_refunding: [{
|
|
3097
|
+
origination_entry_point: "495147f647",
|
|
3098
|
+
account_id: "187-342",
|
|
3099
|
+
description: "Refunding undelivered materials",
|
|
3100
|
+
amount: 60
|
|
3101
|
+
}, {
|
|
3102
|
+
origination_entry_point: "8cfec329267",
|
|
3103
|
+
account_id: "187-343",
|
|
3104
|
+
description: "Refunding deposit for undelivered materials",
|
|
3105
|
+
amount: 40
|
|
3106
|
+
}]
|
|
3107
|
+
},
|
|
3108
|
+
source: "api"
|
|
3109
|
+
)
|
|
3136
3110
|
```
|
|
3137
3111
|
</dd>
|
|
3138
3112
|
</dl>
|
|
@@ -3192,7 +3166,7 @@ Refund a transaction that has settled and send money back to the account holder.
|
|
|
3192
3166
|
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
3167
|
|
|
3194
3168
|
<Note>
|
|
3195
|
-
|
|
3169
|
+
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
3170
|
</Note>
|
|
3197
3171
|
</dd>
|
|
3198
3172
|
</dl>
|
|
@@ -3210,7 +3184,22 @@ This is the v2 version of the refund endpoint, and returns the unified response
|
|
|
3210
3184
|
```ruby
|
|
3211
3185
|
client.money_in.refundv_2_amount(
|
|
3212
3186
|
trans_id: "10-3ffa27df-b171-44e0-b251-e95fbfc7a723",
|
|
3213
|
-
amount:
|
|
3187
|
+
amount: 70,
|
|
3188
|
+
order_description: "Materials deposit",
|
|
3189
|
+
refund_details: {
|
|
3190
|
+
split_refunding: [{
|
|
3191
|
+
origination_entry_point: "495147f647",
|
|
3192
|
+
account_id: "187-342",
|
|
3193
|
+
description: "Refunding undelivered materials",
|
|
3194
|
+
amount: 40
|
|
3195
|
+
}, {
|
|
3196
|
+
origination_entry_point: "8cfec329267",
|
|
3197
|
+
account_id: "187-343",
|
|
3198
|
+
description: "Refunding deposit for undelivered materials",
|
|
3199
|
+
amount: 30
|
|
3200
|
+
}]
|
|
3201
|
+
},
|
|
3202
|
+
source: "api"
|
|
3214
3203
|
)
|
|
3215
3204
|
```
|
|
3216
3205
|
</dd>
|
|
@@ -4444,7 +4433,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
4444
4433
|
|
|
4445
4434
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
4446
4435
|
|
|
4447
|
-
|
|
4436
|
+
Accepted field names:
|
|
4448
4437
|
|
|
4449
4438
|
- `invoiceDate` (gt, ge, lt, le, eq, ne)
|
|
4450
4439
|
- `dueDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -4485,7 +4474,7 @@ List of field names accepted:
|
|
|
4485
4474
|
- `orgName` (ne, eq, ct, nct)
|
|
4486
4475
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
4487
4476
|
|
|
4488
|
-
|
|
4477
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
4489
4478
|
|
|
4490
4479
|
- eq or empty => equal
|
|
4491
4480
|
- gt => greater than
|
|
@@ -4498,7 +4487,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
4498
4487
|
- in => inside array
|
|
4499
4488
|
- nin => not inside array
|
|
4500
4489
|
|
|
4501
|
-
|
|
4490
|
+
Accepted parameters:
|
|
4502
4491
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
4503
4492
|
- fromRecord : initial record in query
|
|
4504
4493
|
|
|
@@ -4615,7 +4604,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
4615
4604
|
|
|
4616
4605
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
4617
4606
|
|
|
4618
|
-
|
|
4607
|
+
Accepted field names:
|
|
4619
4608
|
|
|
4620
4609
|
- `invoiceDate` (gt, ge, lt, le, eq, ne)
|
|
4621
4610
|
- `dueDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -4656,7 +4645,7 @@ List of field names accepted:
|
|
|
4656
4645
|
- `orgName` (ne, eq, ct, nct)
|
|
4657
4646
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
4658
4647
|
|
|
4659
|
-
|
|
4648
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
4660
4649
|
|
|
4661
4650
|
- eq or empty => equal
|
|
4662
4651
|
- gt => greater than
|
|
@@ -4669,7 +4658,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
4669
4658
|
- in => inside array
|
|
4670
4659
|
- nin => not inside array
|
|
4671
4660
|
|
|
4672
|
-
|
|
4661
|
+
Accepted parameters:
|
|
4673
4662
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
4674
4663
|
- fromRecord : initial record in query
|
|
4675
4664
|
|
|
@@ -8147,9 +8136,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
8147
8136
|
<Info>
|
|
8148
8137
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
8149
8138
|
|
|
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:
|
|
8139
|
+
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
8140
|
|
|
8154
8141
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
8155
8142
|
|
|
@@ -8160,7 +8147,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
8160
8147
|
|
|
8161
8148
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
8162
8149
|
|
|
8163
|
-
**
|
|
8150
|
+
**Accepted field names:**
|
|
8164
8151
|
|
|
8165
8152
|
- `settlementDate` (gt, ge, lt, le, eq, ne)
|
|
8166
8153
|
- `depositDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -8200,7 +8187,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
8200
8187
|
- `batchId` (ct, nct, eq, neq)
|
|
8201
8188
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
8202
8189
|
|
|
8203
|
-
**
|
|
8190
|
+
**Accepted comparison operators:**
|
|
8204
8191
|
- `eq` or empty => equal
|
|
8205
8192
|
- `gt` => greater than
|
|
8206
8193
|
- `ge` => greater or equal
|
|
@@ -8212,7 +8199,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
8212
8199
|
- `in` => inside array separated by "|"
|
|
8213
8200
|
- `nin` => not inside array separated by "|"
|
|
8214
8201
|
|
|
8215
|
-
**
|
|
8202
|
+
**Accepted parameters:**
|
|
8216
8203
|
|
|
8217
8204
|
- `limitRecord`: max number of records for query (default="20", "0" or negative value for all)
|
|
8218
8205
|
- `fromRecord`: initial record in query
|
|
@@ -8330,9 +8317,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
8330
8317
|
<Info>
|
|
8331
8318
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
8332
8319
|
|
|
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:
|
|
8320
|
+
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
8321
|
|
|
8337
8322
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
8338
8323
|
|
|
@@ -8342,7 +8327,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
8342
8327
|
</Info>
|
|
8343
8328
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
8344
8329
|
|
|
8345
|
-
**
|
|
8330
|
+
**Accepted field names:**
|
|
8346
8331
|
|
|
8347
8332
|
- `settlementDate` (gt, ge, lt, le, eq, ne)
|
|
8348
8333
|
- `depositDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -8382,7 +8367,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
8382
8367
|
- `batchId` (ct, nct, eq, neq)
|
|
8383
8368
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
8384
8369
|
|
|
8385
|
-
**
|
|
8370
|
+
**Accepted comparison operators:**
|
|
8386
8371
|
- `eq` or empty => equal
|
|
8387
8372
|
- `gt` => greater than
|
|
8388
8373
|
- `ge` => greater or equal
|
|
@@ -8394,7 +8379,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
8394
8379
|
- `in` => inside array separated by "|"
|
|
8395
8380
|
- `nin` => not inside array separated by "|"
|
|
8396
8381
|
|
|
8397
|
-
**
|
|
8382
|
+
**Accepted parameters:**
|
|
8398
8383
|
|
|
8399
8384
|
- `limitRecord`: max number of records for query (default="20", "0" or negative value for all)
|
|
8400
8385
|
- `fromRecord`: initial record in query
|
|
@@ -8512,9 +8497,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
8512
8497
|
<Info>
|
|
8513
8498
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
8514
8499
|
|
|
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:
|
|
8500
|
+
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
8501
|
|
|
8519
8502
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
8520
8503
|
|
|
@@ -8525,7 +8508,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
8525
8508
|
|
|
8526
8509
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
8527
8510
|
|
|
8528
|
-
**
|
|
8511
|
+
**Accepted field names:**
|
|
8529
8512
|
|
|
8530
8513
|
- `batchDate` (gt, ge, lt, le, eq, ne)
|
|
8531
8514
|
- `batchNumber` (ne, eq)
|
|
@@ -8557,7 +8540,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
8557
8540
|
- `processor` (ne, eq, ct, nct)
|
|
8558
8541
|
- `transferStatus` (ne, eq, in, nin)
|
|
8559
8542
|
|
|
8560
|
-
**
|
|
8543
|
+
**Accepted parameters:**
|
|
8561
8544
|
- `limitRecord`: max number of records for query (default="20", "0" or negative value for all)
|
|
8562
8545
|
- `fromRecord`: initial record in query
|
|
8563
8546
|
|
|
@@ -8674,9 +8657,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
8674
8657
|
<Info>
|
|
8675
8658
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
8676
8659
|
|
|
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:
|
|
8660
|
+
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
8661
|
|
|
8681
8662
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
8682
8663
|
|
|
@@ -8687,7 +8668,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
8687
8668
|
|
|
8688
8669
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
8689
8670
|
|
|
8690
|
-
**
|
|
8671
|
+
**Accepted field names:**
|
|
8691
8672
|
|
|
8692
8673
|
- `batchDate` (gt, ge, lt, le, eq, ne)
|
|
8693
8674
|
- `batchNumber` (ne, eq)
|
|
@@ -8719,7 +8700,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
8719
8700
|
- `processor` (ne, eq, ct, nct)
|
|
8720
8701
|
- `transferStatus` (ne, eq, in, nin)
|
|
8721
8702
|
|
|
8722
|
-
**
|
|
8703
|
+
**Accepted parameters:**
|
|
8723
8704
|
- `limitRecord`: max number of records for query (default="20", "0" or negative value for all)
|
|
8724
8705
|
- `fromRecord`: initial record in query
|
|
8725
8706
|
|
|
@@ -8834,7 +8815,7 @@ client.query.list_batches_out(
|
|
|
8834
8815
|
|
|
8835
8816
|
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
8817
|
|
|
8837
|
-
**
|
|
8818
|
+
**Accepted field names**:
|
|
8838
8819
|
|
|
8839
8820
|
- `batchDate` (gt, ge, lt, le, eq, ne)
|
|
8840
8821
|
- `batchNumber` (ne, eq)
|
|
@@ -8959,9 +8940,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
8959
8940
|
<Info>
|
|
8960
8941
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
8961
8942
|
|
|
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:
|
|
8943
|
+
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
8944
|
|
|
8966
8945
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
8967
8946
|
|
|
@@ -8972,7 +8951,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
8972
8951
|
|
|
8973
8952
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
8974
8953
|
|
|
8975
|
-
**
|
|
8954
|
+
**Accepted field names**:
|
|
8976
8955
|
|
|
8977
8956
|
- `batchDate` (gt, ge, lt, le, eq, ne)
|
|
8978
8957
|
- `batchNumber` (ne, eq)
|
|
@@ -9097,9 +9076,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
9097
9076
|
<Info>
|
|
9098
9077
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
9099
9078
|
|
|
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:
|
|
9079
|
+
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
9080
|
|
|
9104
9081
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
9105
9082
|
|
|
@@ -9109,7 +9086,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
9109
9086
|
</Info>
|
|
9110
9087
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
9111
9088
|
|
|
9112
|
-
**
|
|
9089
|
+
**Accepted field names:**
|
|
9113
9090
|
- `chargebackDate` (gt, ge, lt, le, eq, ne)
|
|
9114
9091
|
- `transId` (ne, eq, ct, nct)
|
|
9115
9092
|
- `method` (in, nin, eq, ne)
|
|
@@ -9147,7 +9124,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
9147
9124
|
- `orgName` (ne, eq, ct, nct)
|
|
9148
9125
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
9149
9126
|
|
|
9150
|
-
**
|
|
9127
|
+
**Accepted comparison operators - enclosed between parentheses:**
|
|
9151
9128
|
- `eq` or empty => equal
|
|
9152
9129
|
- `gt` => greater than
|
|
9153
9130
|
- `ge` => greater or equal
|
|
@@ -9159,7 +9136,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
9159
9136
|
- `in` => inside array separated by "|"
|
|
9160
9137
|
- `nin` => not inside array separated by "|"
|
|
9161
9138
|
|
|
9162
|
-
**
|
|
9139
|
+
**Accepted parameters:**
|
|
9163
9140
|
- `limitRecord`: max number of records for query (default="20", "0" or negative value for all)
|
|
9164
9141
|
- `fromRecord`: initial record in query
|
|
9165
9142
|
|
|
@@ -9277,9 +9254,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
9277
9254
|
<Info>
|
|
9278
9255
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
9279
9256
|
|
|
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:
|
|
9257
|
+
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
9258
|
|
|
9284
9259
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
9285
9260
|
|
|
@@ -9288,7 +9263,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
9288
9263
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
9289
9264
|
</Info> See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
9290
9265
|
|
|
9291
|
-
**
|
|
9266
|
+
**Accepted field names:**
|
|
9292
9267
|
|
|
9293
9268
|
- `chargebackDate` (gt, ge, lt, le, eq, ne)
|
|
9294
9269
|
- `transId` (ne, eq, ct, nct)
|
|
@@ -9327,7 +9302,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
9327
9302
|
- `orgName` (ne, eq, ct, nct)
|
|
9328
9303
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
9329
9304
|
|
|
9330
|
-
**
|
|
9305
|
+
**Accepted comparison operators - enclosed between parentheses:**
|
|
9331
9306
|
|
|
9332
9307
|
- `eq` or empty => equal
|
|
9333
9308
|
- `gt` => greater than
|
|
@@ -9340,7 +9315,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
9340
9315
|
- `in` => inside array separated by "|"
|
|
9341
9316
|
- `nin` => not inside array separated by "|"
|
|
9342
9317
|
|
|
9343
|
-
**
|
|
9318
|
+
**Accepted parameters:**
|
|
9344
9319
|
- `limitRecord`: max number of records for query (default="20", "0" or negative value for all)
|
|
9345
9320
|
- `fromRecord`: initial record in query
|
|
9346
9321
|
|
|
@@ -9457,9 +9432,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
9457
9432
|
<Info>
|
|
9458
9433
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
9459
9434
|
|
|
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:
|
|
9435
|
+
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
9436
|
|
|
9464
9437
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
9465
9438
|
|
|
@@ -9469,7 +9442,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
9469
9442
|
</Info>
|
|
9470
9443
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more details.
|
|
9471
9444
|
|
|
9472
|
-
**
|
|
9445
|
+
**Accepted field names:**
|
|
9473
9446
|
|
|
9474
9447
|
- `createdDate` (gt, ge, lt, le, eq, ne)
|
|
9475
9448
|
- `customernumber` (ne, eq, ct, nct)
|
|
@@ -9499,7 +9472,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
9499
9472
|
- `paypointDba` (ne, eq, ct, nct)
|
|
9500
9473
|
- `orgName` (ne, eq, ct, nct)
|
|
9501
9474
|
|
|
9502
|
-
**
|
|
9475
|
+
**Accepted comparison operators:**
|
|
9503
9476
|
|
|
9504
9477
|
- `eq` or empty => equal
|
|
9505
9478
|
- `gt` => greater than
|
|
@@ -9512,7 +9485,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
9512
9485
|
- `in` => inside array separated by "|"
|
|
9513
9486
|
- `nin` => not inside array separated by "|"
|
|
9514
9487
|
|
|
9515
|
-
**Accepted
|
|
9488
|
+
**Accepted parameters:**
|
|
9516
9489
|
- `limitRecord`: Max number of records for query (default="20", "0" or negative value for all)
|
|
9517
9490
|
- `fromRecord`: Initial record in query
|
|
9518
9491
|
|
|
@@ -9630,9 +9603,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
9630
9603
|
<Info>
|
|
9631
9604
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
9632
9605
|
|
|
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:
|
|
9606
|
+
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
9607
|
|
|
9637
9608
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
9638
9609
|
|
|
@@ -9642,7 +9613,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
9642
9613
|
</Info>
|
|
9643
9614
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more details.
|
|
9644
9615
|
|
|
9645
|
-
**
|
|
9616
|
+
**Accepted field names:**
|
|
9646
9617
|
|
|
9647
9618
|
- `createdDate` (gt, ge, lt, le, eq, ne)
|
|
9648
9619
|
- `customernumber` (ne, eq, ct, nct)
|
|
@@ -9672,7 +9643,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
9672
9643
|
- `paypointDba` (ne, eq, ct, nct)
|
|
9673
9644
|
- `orgName` (ne, eq, ct, nct)
|
|
9674
9645
|
|
|
9675
|
-
**
|
|
9646
|
+
**Accepted comparison operators:**
|
|
9676
9647
|
|
|
9677
9648
|
- `eq` or empty => equal
|
|
9678
9649
|
- `gt` => greater than
|
|
@@ -9685,7 +9656,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
9685
9656
|
- `in` => inside array separated by "|"
|
|
9686
9657
|
- `nin` => not inside array separated by "|"
|
|
9687
9658
|
|
|
9688
|
-
**Accepted
|
|
9659
|
+
**Accepted parameters:**
|
|
9689
9660
|
- `limitRecord`: Max number of records for query (default="20", "0" or negative value for all)
|
|
9690
9661
|
- `fromRecord`: Initial record in query
|
|
9691
9662
|
|
|
@@ -9805,9 +9776,7 @@ the query.
|
|
|
9805
9776
|
<Info>
|
|
9806
9777
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
9807
9778
|
|
|
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:
|
|
9779
|
+
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
9780
|
|
|
9812
9781
|
--url https://api-sandbox.payabli.com/api/Query/devices/8cfec329267?parameters=status=1&limitRecord=20
|
|
9813
9782
|
|
|
@@ -9820,7 +9789,7 @@ See [Filters and Conditions
|
|
|
9820
9789
|
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
|
|
9821
9790
|
for more information.
|
|
9822
9791
|
|
|
9823
|
-
**
|
|
9792
|
+
**Accepted field names:**
|
|
9824
9793
|
|
|
9825
9794
|
|
|
9826
9795
|
- `deviceId` (eq, ne, ct, nct)
|
|
@@ -9869,8 +9838,16 @@ for more information.
|
|
|
9869
9838
|
|
|
9870
9839
|
- `parentOrgName` (eq, ne, ct, nct)
|
|
9871
9840
|
|
|
9841
|
+
- `paypointLogo` (eq, ne, ct, nct)
|
|
9842
|
+
|
|
9843
|
+
- `parentOrgLogo` (eq, ne, ct, nct)
|
|
9872
9844
|
|
|
9873
|
-
|
|
9845
|
+
- `transactionCount` (eq, ne, gt, ge, lt, le)
|
|
9846
|
+
|
|
9847
|
+
- `volumeProcessed` (eq, ne, gt, ge, lt, le)
|
|
9848
|
+
|
|
9849
|
+
|
|
9850
|
+
**Accepted comparison operators:**
|
|
9874
9851
|
|
|
9875
9852
|
- `eq` or empty => equal
|
|
9876
9853
|
|
|
@@ -10005,9 +9982,7 @@ the query.
|
|
|
10005
9982
|
<Info>
|
|
10006
9983
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
10007
9984
|
|
|
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:
|
|
9985
|
+
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
9986
|
|
|
10012
9987
|
--url https://api-sandbox.payabli.com/api/Query/devices/org/236?parameters=status=1&limitRecord=20
|
|
10013
9988
|
|
|
@@ -10020,7 +9995,7 @@ See [Filters and Conditions
|
|
|
10020
9995
|
Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference)
|
|
10021
9996
|
for more information.
|
|
10022
9997
|
|
|
10023
|
-
**
|
|
9998
|
+
**Accepted field names:**
|
|
10024
9999
|
|
|
10025
10000
|
|
|
10026
10001
|
- `deviceId` (eq, ne, ct, nct)
|
|
@@ -10069,8 +10044,16 @@ for more information.
|
|
|
10069
10044
|
|
|
10070
10045
|
- `parentOrgName` (eq, ne, ct, nct)
|
|
10071
10046
|
|
|
10047
|
+
- `paypointLogo` (eq, ne, ct, nct)
|
|
10048
|
+
|
|
10049
|
+
- `parentOrgLogo` (eq, ne, ct, nct)
|
|
10050
|
+
|
|
10051
|
+
- `transactionCount` (eq, ne, gt, ge, lt, le)
|
|
10072
10052
|
|
|
10073
|
-
|
|
10053
|
+
- `volumeProcessed` (eq, ne, gt, ge, lt, le)
|
|
10054
|
+
|
|
10055
|
+
|
|
10056
|
+
**Accepted comparison operators:**
|
|
10074
10057
|
|
|
10075
10058
|
- `eq` or empty => equal
|
|
10076
10059
|
|
|
@@ -10195,9 +10178,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
10195
10178
|
<Info>
|
|
10196
10179
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
10197
10180
|
|
|
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:
|
|
10181
|
+
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
10182
|
|
|
10202
10183
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
10203
10184
|
|
|
@@ -10208,11 +10189,11 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
10208
10189
|
|
|
10209
10190
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
10210
10191
|
|
|
10211
|
-
|
|
10192
|
+
**Accepted field names:**
|
|
10212
10193
|
- `reportName` (ct, nct, eq, ne)
|
|
10213
10194
|
- `createdAt` (gt, ge, lt, le, eq, ne)
|
|
10214
10195
|
|
|
10215
|
-
|
|
10196
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
10216
10197
|
- eq or empty => equal
|
|
10217
10198
|
- gt => greater than
|
|
10218
10199
|
- ge => greater or equal
|
|
@@ -10224,7 +10205,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
10224
10205
|
- in => inside array
|
|
10225
10206
|
- nin => not inside array
|
|
10226
10207
|
|
|
10227
|
-
|
|
10208
|
+
Accepted parameters:
|
|
10228
10209
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
10229
10210
|
- fromRecord : initial record in query
|
|
10230
10211
|
|
|
@@ -10332,9 +10313,7 @@ client.query.list_notification_reports_org(
|
|
|
10332
10313
|
Collection of field names, conditions, and values used to filter the query <Info>
|
|
10333
10314
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
10334
10315
|
|
|
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:
|
|
10316
|
+
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
10317
|
|
|
10339
10318
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
10340
10319
|
|
|
@@ -10344,11 +10323,11 @@ Collection of field names, conditions, and values used to filter the query <Info
|
|
|
10344
10323
|
</Info>
|
|
10345
10324
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
10346
10325
|
|
|
10347
|
-
|
|
10326
|
+
**Accepted field names:**
|
|
10348
10327
|
- `reportName` (ct, nct, eq, ne)
|
|
10349
10328
|
- `createdAt` (gt, ge, lt, le, eq, ne)
|
|
10350
10329
|
|
|
10351
|
-
|
|
10330
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
10352
10331
|
- eq or empty => equal
|
|
10353
10332
|
- gt => greater than
|
|
10354
10333
|
- ge => greater or equal
|
|
@@ -10360,7 +10339,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
10360
10339
|
- in => inside array
|
|
10361
10340
|
- nin => not inside array
|
|
10362
10341
|
|
|
10363
|
-
|
|
10342
|
+
Accepted parameters:
|
|
10364
10343
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
10365
10344
|
- fromRecord : initial record in query
|
|
10366
10345
|
|
|
@@ -10469,9 +10448,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
10469
10448
|
<Info>
|
|
10470
10449
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
10471
10450
|
|
|
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:
|
|
10451
|
+
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
10452
|
|
|
10476
10453
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
10477
10454
|
|
|
@@ -10481,14 +10458,14 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
10481
10458
|
</Info>
|
|
10482
10459
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
10483
10460
|
|
|
10484
|
-
|
|
10461
|
+
**Accepted field names:**
|
|
10485
10462
|
- `frequency` (in, nin,ne, eq)
|
|
10486
10463
|
- `method` (in, nin, eq, ne)
|
|
10487
10464
|
- `event` (in, nin, eq, ne)
|
|
10488
10465
|
- `target` (ct, nct, eq, ne)
|
|
10489
10466
|
- `status` (eq, ne)
|
|
10490
10467
|
|
|
10491
|
-
|
|
10468
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
10492
10469
|
- eq or empty => equal
|
|
10493
10470
|
- gt => greater than
|
|
10494
10471
|
- ge => greater or equal
|
|
@@ -10500,7 +10477,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
10500
10477
|
- in => inside array
|
|
10501
10478
|
- nin => not inside array
|
|
10502
10479
|
|
|
10503
|
-
|
|
10480
|
+
Accepted parameters:
|
|
10504
10481
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
10505
10482
|
- fromRecord : initial record in query
|
|
10506
10483
|
|
|
@@ -10609,9 +10586,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
10609
10586
|
<Info>
|
|
10610
10587
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
10611
10588
|
|
|
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:
|
|
10589
|
+
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
10590
|
|
|
10616
10591
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
10617
10592
|
|
|
@@ -10621,14 +10596,14 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
10621
10596
|
</Info>
|
|
10622
10597
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
10623
10598
|
|
|
10624
|
-
|
|
10599
|
+
**Accepted field names:**
|
|
10625
10600
|
- `frequency` (in, nin,ne, eq)
|
|
10626
10601
|
- `method` (in, nin, eq, ne)
|
|
10627
10602
|
- `event` (in, nin, eq, ne)
|
|
10628
10603
|
- `target` (ct, nct, eq, ne)
|
|
10629
10604
|
- `status` (eq, ne)
|
|
10630
10605
|
|
|
10631
|
-
|
|
10606
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
10632
10607
|
- eq or empty => equal
|
|
10633
10608
|
- gt => greater than
|
|
10634
10609
|
- ge => greater or equal
|
|
@@ -10640,7 +10615,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
10640
10615
|
- in => inside array
|
|
10641
10616
|
- nin => not inside array
|
|
10642
10617
|
|
|
10643
|
-
|
|
10618
|
+
Accepted parameters:
|
|
10644
10619
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
10645
10620
|
- fromRecord : initial record in query
|
|
10646
10621
|
|
|
@@ -10757,9 +10732,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
10757
10732
|
<Info>
|
|
10758
10733
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
10759
10734
|
|
|
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:
|
|
10735
|
+
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
10736
|
|
|
10764
10737
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
10765
10738
|
|
|
@@ -10767,7 +10740,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
10767
10740
|
|
|
10768
10741
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
10769
10742
|
</Info>
|
|
10770
|
-
**
|
|
10743
|
+
**Accepted field names:**
|
|
10771
10744
|
|
|
10772
10745
|
- `createdAt` (gt, ge, lt, le, eq, ne)
|
|
10773
10746
|
- `startDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -10786,7 +10759,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
10786
10759
|
- `boardingId` (eq, ne)
|
|
10787
10760
|
- `entryName` (ct, nct)
|
|
10788
10761
|
|
|
10789
|
-
**
|
|
10762
|
+
**Accepted comparison operators - enclosed between parentheses:**
|
|
10790
10763
|
|
|
10791
10764
|
- `eq` or empty => equal
|
|
10792
10765
|
- `gt` => greater than
|
|
@@ -10799,7 +10772,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
10799
10772
|
- `in` => inside array
|
|
10800
10773
|
- `nin` => not inside array
|
|
10801
10774
|
|
|
10802
|
-
**
|
|
10775
|
+
**Accepted parameters:**
|
|
10803
10776
|
|
|
10804
10777
|
- `limitRecord` : max number of records for query (default="20", "0" or negative value for all)
|
|
10805
10778
|
- `fromRecord` : initial record in query
|
|
@@ -10917,9 +10890,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
10917
10890
|
<Info>
|
|
10918
10891
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
10919
10892
|
|
|
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:
|
|
10893
|
+
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
10894
|
|
|
10924
10895
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
10925
10896
|
|
|
@@ -10928,7 +10899,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
10928
10899
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
10929
10900
|
</Info>
|
|
10930
10901
|
|
|
10931
|
-
|
|
10902
|
+
Accepted field names:
|
|
10932
10903
|
|
|
10933
10904
|
- `status` (in, nin, eq, ne)
|
|
10934
10905
|
- `transactionDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -10971,7 +10942,7 @@ List of field names accepted:
|
|
|
10971
10942
|
- `AchTraceNumber` (eq, ne)
|
|
10972
10943
|
- `payoutProgram`(eq, ne) the options are `managed` or `odp`. For example, `payoutProgram(eq)=managed` returns all records with a `payoutProgram` equal to `managed`.
|
|
10973
10944
|
|
|
10974
|
-
|
|
10945
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
10975
10946
|
- eq or empty => equal
|
|
10976
10947
|
- gt => greater than
|
|
10977
10948
|
- ge => greater or equal
|
|
@@ -10983,7 +10954,7 @@ List of field names accepted:
|
|
|
10983
10954
|
- in => inside array separated by \"|\"
|
|
10984
10955
|
- nin => not inside array separated by \"|\"
|
|
10985
10956
|
|
|
10986
|
-
|
|
10957
|
+
Accepted parameters:
|
|
10987
10958
|
|
|
10988
10959
|
- limitRecord : max number of records for query (default=\"20\", \"0\" or negative value for all)
|
|
10989
10960
|
- fromRecord : initial record in query
|
|
@@ -11104,9 +11075,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
11104
11075
|
<Info>
|
|
11105
11076
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
11106
11077
|
|
|
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:
|
|
11078
|
+
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
11079
|
|
|
11111
11080
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
11112
11081
|
|
|
@@ -11114,7 +11083,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
11114
11083
|
|
|
11115
11084
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
11116
11085
|
</Info>
|
|
11117
|
-
|
|
11086
|
+
Accepted field names:
|
|
11118
11087
|
|
|
11119
11088
|
- `status` (in, nin, eq, ne)
|
|
11120
11089
|
- `transactionDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -11157,7 +11126,7 @@ List of field names accepted:
|
|
|
11157
11126
|
- `AchTraceNumber` (eq, ne)
|
|
11158
11127
|
- `payoutProgram`(eq, ne) the options are `managed` or `odp`. For example, `payoutProgram(eq)=managed` returns all records with a `payoutProgram` equal to `managed`.
|
|
11159
11128
|
|
|
11160
|
-
|
|
11129
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
11161
11130
|
- eq or empty => equal
|
|
11162
11131
|
- gt => greater than
|
|
11163
11132
|
- ge => greater or equal
|
|
@@ -11169,7 +11138,7 @@ List of field names accepted:
|
|
|
11169
11138
|
- in => inside array separated by \"|\"
|
|
11170
11139
|
- nin => not inside array separated by \"|\"
|
|
11171
11140
|
|
|
11172
|
-
|
|
11141
|
+
Accepted parameters:
|
|
11173
11142
|
|
|
11174
11143
|
- limitRecord : max number of records for query (default=\"20\", \"0\" or negative value for all)
|
|
11175
11144
|
- fromRecord : initial record in query
|
|
@@ -11290,9 +11259,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
11290
11259
|
<Info>
|
|
11291
11260
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
11292
11261
|
|
|
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:
|
|
11262
|
+
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
11263
|
|
|
11297
11264
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
11298
11265
|
|
|
@@ -11300,7 +11267,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
11300
11267
|
|
|
11301
11268
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
11302
11269
|
</Info>
|
|
11303
|
-
**
|
|
11270
|
+
**Accepted field names:**
|
|
11304
11271
|
|
|
11305
11272
|
- `createdAt` (gt, ge, lt, le, eq, ne)
|
|
11306
11273
|
- `lastModified` (gt, ge, lt, le, eq, ne)
|
|
@@ -11324,7 +11291,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
11324
11291
|
- `entryName` (ct, nct)
|
|
11325
11292
|
- `externalOrgID` (ct, nct)
|
|
11326
11293
|
|
|
11327
|
-
**
|
|
11294
|
+
**Accepted comparison operators - enclosed between parentheses:**
|
|
11328
11295
|
|
|
11329
11296
|
- `eq` or empty => equal
|
|
11330
11297
|
- `gt` => greater than
|
|
@@ -11337,7 +11304,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
11337
11304
|
- `in` => inside array
|
|
11338
11305
|
- `nin` => not inside array
|
|
11339
11306
|
|
|
11340
|
-
**
|
|
11307
|
+
**Accepted parameters:**
|
|
11341
11308
|
|
|
11342
11309
|
- `limitRecord` : max number of records for query (default="20", "0" or negative value for all)
|
|
11343
11310
|
- `fromRecord` : initial record in query
|
|
@@ -11455,9 +11422,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
11455
11422
|
<Info>
|
|
11456
11423
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
11457
11424
|
|
|
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:
|
|
11425
|
+
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
11426
|
|
|
11462
11427
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
11463
11428
|
|
|
@@ -11468,7 +11433,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
11468
11433
|
|
|
11469
11434
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
11470
11435
|
|
|
11471
|
-
**
|
|
11436
|
+
**Accepted field names:**
|
|
11472
11437
|
|
|
11473
11438
|
- `settlementDate` (gt, ge, lt, le, eq, ne)
|
|
11474
11439
|
- `depositDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -11508,7 +11473,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
11508
11473
|
- `batchId` (ct, nct, eq, neq)
|
|
11509
11474
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
11510
11475
|
|
|
11511
|
-
**
|
|
11476
|
+
**Accepted comparison operators:**
|
|
11512
11477
|
- `eq` or empty => equal
|
|
11513
11478
|
- `gt` => greater than
|
|
11514
11479
|
- `ge` => greater or equal
|
|
@@ -11520,7 +11485,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
11520
11485
|
- `in` => inside array separated by "|"
|
|
11521
11486
|
- `nin` => not inside array separated by "|"
|
|
11522
11487
|
|
|
11523
|
-
**
|
|
11488
|
+
**Accepted parameters:**
|
|
11524
11489
|
|
|
11525
11490
|
- `limitRecord`: max number of records for query (default="20", "0" or negative value for all)
|
|
11526
11491
|
- `fromRecord`: initial record in query
|
|
@@ -11638,9 +11603,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
11638
11603
|
<Info>
|
|
11639
11604
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
11640
11605
|
|
|
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:
|
|
11606
|
+
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
11607
|
|
|
11645
11608
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
11646
11609
|
|
|
@@ -11651,7 +11614,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
11651
11614
|
|
|
11652
11615
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
11653
11616
|
|
|
11654
|
-
**
|
|
11617
|
+
**Accepted field names:**
|
|
11655
11618
|
|
|
11656
11619
|
- `settlementDate` (gt, ge, lt, le, eq, ne)
|
|
11657
11620
|
- `depositDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -11691,7 +11654,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
11691
11654
|
- `batchId` (ct, nct, eq, neq)
|
|
11692
11655
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
11693
11656
|
|
|
11694
|
-
**
|
|
11657
|
+
**Accepted comparison operators:**
|
|
11695
11658
|
- `eq` or empty => equal
|
|
11696
11659
|
- `gt` => greater than
|
|
11697
11660
|
- `ge` => greater or equal
|
|
@@ -11703,7 +11666,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
11703
11666
|
- `in` => inside array separated by "|"
|
|
11704
11667
|
- `nin` => not inside array separated by "|"
|
|
11705
11668
|
|
|
11706
|
-
**
|
|
11669
|
+
**Accepted parameters:**
|
|
11707
11670
|
|
|
11708
11671
|
- `limitRecord`: max number of records for query (default="20", "0" or negative value for all)
|
|
11709
11672
|
- `fromRecord`: initial record in query
|
|
@@ -11821,9 +11784,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
11821
11784
|
<Info>
|
|
11822
11785
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
11823
11786
|
|
|
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:
|
|
11787
|
+
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
11788
|
|
|
11828
11789
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
11829
11790
|
|
|
@@ -11833,7 +11794,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
11833
11794
|
</Info>
|
|
11834
11795
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
11835
11796
|
|
|
11836
|
-
**
|
|
11797
|
+
**Accepted field names:**
|
|
11837
11798
|
|
|
11838
11799
|
- `startDate` (gt, ge, lt, le, eq, ne)
|
|
11839
11800
|
- `endDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -11883,7 +11844,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
11883
11844
|
- `invoiceNumber` (ct, nct)
|
|
11884
11845
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
11885
11846
|
|
|
11886
|
-
**
|
|
11847
|
+
**Accepted comparison operators:**
|
|
11887
11848
|
- `eq` or empty => equal
|
|
11888
11849
|
- `gt` => greater than
|
|
11889
11850
|
- `ge` => greater or equal
|
|
@@ -12006,9 +11967,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
12006
11967
|
<Info>
|
|
12007
11968
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
12008
11969
|
|
|
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:
|
|
11970
|
+
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
11971
|
|
|
12013
11972
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
12014
11973
|
|
|
@@ -12018,7 +11977,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
12018
11977
|
</Info>
|
|
12019
11978
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
12020
11979
|
|
|
12021
|
-
**
|
|
11980
|
+
**Accepted field names:**
|
|
12022
11981
|
|
|
12023
11982
|
- `startDate` (gt, ge, lt, le, eq, ne)
|
|
12024
11983
|
- `endDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -12068,7 +12027,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
12068
12027
|
- `invoiceNumber` (ct, nct)
|
|
12069
12028
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
12070
12029
|
|
|
12071
|
-
**
|
|
12030
|
+
**Accepted comparison operators:**
|
|
12072
12031
|
- `eq` or empty => equal
|
|
12073
12032
|
- `gt` => greater than
|
|
12074
12033
|
- `ge` => greater or equal
|
|
@@ -12191,9 +12150,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
12191
12150
|
<Info>
|
|
12192
12151
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
12193
12152
|
|
|
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:
|
|
12153
|
+
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
12154
|
|
|
12198
12155
|
--url https://api-sandbox.payabli.com/api/Query/payoutsubscriptions/entry123?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
12199
12156
|
|
|
@@ -12202,7 +12159,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
12202
12159
|
--url https://api-sandbox.payabli.com/api/Query/payoutsubscriptions/entry123?totalAmount(gt)=1000&limitRecord=20
|
|
12203
12160
|
</Info>
|
|
12204
12161
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
12205
|
-
**
|
|
12162
|
+
**Accepted field names:**
|
|
12206
12163
|
|
|
12207
12164
|
- `startDate` (gt, ge, lt, le, eq, ne)
|
|
12208
12165
|
- `endDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -12239,7 +12196,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
12239
12196
|
- `country` (ne, eq, ct, nct)
|
|
12240
12197
|
- `zip` (ne, eq, ct, nct)
|
|
12241
12198
|
|
|
12242
|
-
**
|
|
12199
|
+
**Accepted comparison operators:**
|
|
12243
12200
|
- `eq` or empty => equal
|
|
12244
12201
|
- `gt` => greater than
|
|
12245
12202
|
- `ge` => greater or equal
|
|
@@ -12362,9 +12319,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
12362
12319
|
<Info>
|
|
12363
12320
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
12364
12321
|
|
|
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:
|
|
12322
|
+
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
12323
|
|
|
12369
12324
|
--url https://api-sandbox.payabli.com/api/Query/payoutsubscriptions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
12370
12325
|
|
|
@@ -12373,7 +12328,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
12373
12328
|
--url https://api-sandbox.payabli.com/api/Query/payoutsubscriptions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
12374
12329
|
</Info>
|
|
12375
12330
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
12376
|
-
**
|
|
12331
|
+
**Accepted field names:**
|
|
12377
12332
|
|
|
12378
12333
|
- `startDate` (gt, ge, lt, le, eq, ne)
|
|
12379
12334
|
- `endDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -12410,7 +12365,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
12410
12365
|
- `country` (ne, eq, ct, nct)
|
|
12411
12366
|
- `zip` (ne, eq, ct, nct)
|
|
12412
12367
|
|
|
12413
|
-
**
|
|
12368
|
+
**Accepted comparison operators:**
|
|
12414
12369
|
- `eq` or empty => equal
|
|
12415
12370
|
- `gt` => greater than
|
|
12416
12371
|
- `ge` => greater or equal
|
|
@@ -12542,9 +12497,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
12542
12497
|
<Info>
|
|
12543
12498
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
12544
12499
|
|
|
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:
|
|
12500
|
+
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
12501
|
|
|
12549
12502
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
12550
12503
|
|
|
@@ -12554,7 +12507,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
12554
12507
|
</Info>
|
|
12555
12508
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
12556
12509
|
|
|
12557
|
-
**
|
|
12510
|
+
**Accepted field names:**
|
|
12558
12511
|
|
|
12559
12512
|
- `transactionDate` (gt, ge, lt, le, eq, ne)
|
|
12560
12513
|
- `transId` (ne, eq, ct, nct, in, nin)
|
|
@@ -12612,7 +12565,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
12612
12565
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name related to customer data
|
|
12613
12566
|
- 'invoiceAdditional-xxx' (ne, eq, ct, nct) where xxx is the additional field name related to invoice data
|
|
12614
12567
|
|
|
12615
|
-
**
|
|
12568
|
+
**Accepted comparison operators:**
|
|
12616
12569
|
- `eq` or empty => equal
|
|
12617
12570
|
- `gt` => greater than
|
|
12618
12571
|
- `ge` => greater or equal
|
|
@@ -12744,9 +12697,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
12744
12697
|
<Info>
|
|
12745
12698
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
12746
12699
|
|
|
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:
|
|
12700
|
+
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
12701
|
|
|
12751
12702
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
12752
12703
|
|
|
@@ -12756,7 +12707,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
12756
12707
|
</Info>
|
|
12757
12708
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
12758
12709
|
|
|
12759
|
-
**
|
|
12710
|
+
**Accepted field names:**
|
|
12760
12711
|
|
|
12761
12712
|
- `transactionDate` (gt, ge, lt, le, eq, ne)
|
|
12762
12713
|
- `transId` (ne, eq, ct, nct, in, nin)
|
|
@@ -12813,7 +12764,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
12813
12764
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name related to customer data
|
|
12814
12765
|
- 'invoiceAdditional-xxx' (ne, eq, ct, nct) where xxx is the additional field name related to invoice data
|
|
12815
12766
|
|
|
12816
|
-
**
|
|
12767
|
+
**Accepted comparison operators:**
|
|
12817
12768
|
- `eq` or empty => equal
|
|
12818
12769
|
- `gt` => greater than
|
|
12819
12770
|
- `ge` => greater or equal
|
|
@@ -12944,9 +12895,7 @@ the query.
|
|
|
12944
12895
|
<Info>
|
|
12945
12896
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
12946
12897
|
|
|
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:
|
|
12898
|
+
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
12899
|
|
|
12951
12900
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
12952
12901
|
|
|
@@ -12960,7 +12909,7 @@ Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filter
|
|
|
12960
12909
|
for more information.
|
|
12961
12910
|
|
|
12962
12911
|
|
|
12963
|
-
**
|
|
12912
|
+
**Accepted field names:**
|
|
12964
12913
|
|
|
12965
12914
|
- `grossAmount` (gt, ge, lt, le, eq, ne)
|
|
12966
12915
|
- `chargeBackAmount` (gt, ge, lt, le, eq, ne)
|
|
@@ -13096,7 +13045,7 @@ Collection of field names, conditions, and values used to filter the query. See
|
|
|
13096
13045
|
|
|
13097
13046
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
13098
13047
|
</Info>
|
|
13099
|
-
|
|
13048
|
+
Accepted field names:
|
|
13100
13049
|
|
|
13101
13050
|
- `transferDate` (gt, ge, lt, le, eq, ne)
|
|
13102
13051
|
- `grossAmount` (gt, ge, lt, le, eq, ne)
|
|
@@ -13238,7 +13187,7 @@ Collection of field names, conditions, and values used to filter the query. See
|
|
|
13238
13187
|
|
|
13239
13188
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
13240
13189
|
</Info>
|
|
13241
|
-
|
|
13190
|
+
Accepted field names:
|
|
13242
13191
|
|
|
13243
13192
|
- `transferDate` (gt, ge, lt, le, eq, ne)
|
|
13244
13193
|
- `grossAmount` (gt, ge, lt, le, eq, ne)
|
|
@@ -13369,7 +13318,7 @@ Collection of field names, conditions, and values used to filter the query. See
|
|
|
13369
13318
|
|
|
13370
13319
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
13371
13320
|
</Info>
|
|
13372
|
-
|
|
13321
|
+
Accepted field names:
|
|
13373
13322
|
|
|
13374
13323
|
- `transferDate` (gt, ge, lt, le, eq, ne)
|
|
13375
13324
|
- `grossAmount` (gt, ge, lt, le, eq, ne)
|
|
@@ -13498,7 +13447,7 @@ Collection of field names, conditions, and values used to filter the query. See
|
|
|
13498
13447
|
|
|
13499
13448
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
13500
13449
|
</Info>
|
|
13501
|
-
|
|
13450
|
+
Accepted field names:
|
|
13502
13451
|
|
|
13503
13452
|
- `transferDate` (gt, ge, lt, le, eq, ne)
|
|
13504
13453
|
- `grossAmount` (gt, ge, lt, le, eq, ne)
|
|
@@ -13636,7 +13585,7 @@ Collection of field names, conditions, and values used to filter the query. See
|
|
|
13636
13585
|
|
|
13637
13586
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
13638
13587
|
</Info>
|
|
13639
|
-
|
|
13588
|
+
Accepted field names:
|
|
13640
13589
|
|
|
13641
13590
|
- `grossAmount` (gt, ge, lt, le, eq, ne)
|
|
13642
13591
|
- `returnedAmount` (gt, ge, lt, le, eq, ne)
|
|
@@ -13753,9 +13702,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
13753
13702
|
<Info>
|
|
13754
13703
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
13755
13704
|
|
|
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:
|
|
13705
|
+
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
13706
|
|
|
13760
13707
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
13761
13708
|
|
|
@@ -13765,7 +13712,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
13765
13712
|
</Info>
|
|
13766
13713
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
13767
13714
|
|
|
13768
|
-
**
|
|
13715
|
+
**Accepted field names:**
|
|
13769
13716
|
|
|
13770
13717
|
- `createdDate` (gt, ge, lt, le, eq, ne)
|
|
13771
13718
|
- `name` (ne, eq, ct, nct)
|
|
@@ -13773,7 +13720,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
13773
13720
|
- `status` (in, nin, eq, ne)
|
|
13774
13721
|
- `role.xxx` (ne, eq, ct, nct) where xxx is the role field: `roleLabel` or `roleValue`
|
|
13775
13722
|
|
|
13776
|
-
**
|
|
13723
|
+
**Accepted comparison operators - enclosed between parentheses:**
|
|
13777
13724
|
|
|
13778
13725
|
- `eq` or empty => equal
|
|
13779
13726
|
- `gt` => greater than
|
|
@@ -13786,7 +13733,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
13786
13733
|
- `in` => inside array separated by "|"
|
|
13787
13734
|
- `nin` => not inside array separated by "|"
|
|
13788
13735
|
|
|
13789
|
-
**
|
|
13736
|
+
**Accepted parameters:**
|
|
13790
13737
|
- `limitRecord`: max number of records for query (default="20", "0" or negative value for all)
|
|
13791
13738
|
- `fromRecord`: initial record in query
|
|
13792
13739
|
|
|
@@ -13895,9 +13842,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
13895
13842
|
<Info>
|
|
13896
13843
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
13897
13844
|
|
|
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:
|
|
13845
|
+
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
13846
|
|
|
13902
13847
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
13903
13848
|
|
|
@@ -13907,7 +13852,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
13907
13852
|
</Info>
|
|
13908
13853
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
13909
13854
|
|
|
13910
|
-
**
|
|
13855
|
+
**Accepted field names:**
|
|
13911
13856
|
|
|
13912
13857
|
- `createdDate` (gt, ge, lt, le, eq, ne)
|
|
13913
13858
|
- `name` (ne, eq, ct, nct)
|
|
@@ -13915,7 +13860,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
13915
13860
|
- `status` (in, nin, eq, ne)
|
|
13916
13861
|
- `role.xxx` (ne, eq, ct, nct) where xxx is the role field: `roleLabel` or `roleValue`
|
|
13917
13862
|
|
|
13918
|
-
**
|
|
13863
|
+
**Accepted comparison operators - enclosed between parentheses:**
|
|
13919
13864
|
|
|
13920
13865
|
- `eq` or empty => equal
|
|
13921
13866
|
- `gt` => greater than
|
|
@@ -13928,7 +13873,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
13928
13873
|
- `in` => inside array separated by "|"
|
|
13929
13874
|
- `nin` => not inside array separated by "|"
|
|
13930
13875
|
|
|
13931
|
-
**
|
|
13876
|
+
**Accepted parameters:**
|
|
13932
13877
|
- `limitRecord`: max number of records for query (default="20", "0" or negative value for all)
|
|
13933
13878
|
- `fromRecord`: initial record in query
|
|
13934
13879
|
|
|
@@ -14045,9 +13990,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
14045
13990
|
<Info>
|
|
14046
13991
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
14047
13992
|
|
|
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:
|
|
13993
|
+
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
13994
|
|
|
14052
13995
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
14053
13996
|
|
|
@@ -14057,7 +14000,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
14057
14000
|
</Info>
|
|
14058
14001
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
14059
14002
|
|
|
14060
|
-
|
|
14003
|
+
**Accepted field names:**
|
|
14061
14004
|
- `method` (in, nin, eq, ne)
|
|
14062
14005
|
- `enrollmentStatus` (in,nin, eq, ne)
|
|
14063
14006
|
- `status` (in, nin, eq, ne)
|
|
@@ -14079,7 +14022,7 @@ List of field names accepted:
|
|
|
14079
14022
|
- `paypointDba` (ne, eq, ct, nct)
|
|
14080
14023
|
- `orgName` (ne, eq, ct, nct)
|
|
14081
14024
|
|
|
14082
|
-
|
|
14025
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
14083
14026
|
- eq or empty => equal
|
|
14084
14027
|
- gt => greater than
|
|
14085
14028
|
- ge => greater or equal
|
|
@@ -14091,7 +14034,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
14091
14034
|
- in => inside array separated by "|"
|
|
14092
14035
|
- nin => not inside array separated by "|"
|
|
14093
14036
|
|
|
14094
|
-
|
|
14037
|
+
Accepted parameters:
|
|
14095
14038
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
14096
14039
|
- fromRecord : initial record in query
|
|
14097
14040
|
|
|
@@ -14208,9 +14151,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
14208
14151
|
<Info>
|
|
14209
14152
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
14210
14153
|
|
|
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:
|
|
14154
|
+
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
14155
|
|
|
14215
14156
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
14216
14157
|
|
|
@@ -14220,7 +14161,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
14220
14161
|
</Info>
|
|
14221
14162
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
14222
14163
|
|
|
14223
|
-
|
|
14164
|
+
**Accepted field names:**
|
|
14224
14165
|
- `method` (in, nin, eq, ne)
|
|
14225
14166
|
- `enrollmentStatus` (in,nin, eq, ne)
|
|
14226
14167
|
- `status` (in, nin, eq, ne)
|
|
@@ -14242,7 +14183,7 @@ List of field names accepted:
|
|
|
14242
14183
|
- `parentOrgId` (ne, eq, nin, in)
|
|
14243
14184
|
- `orgName` (ne, eq, ct, nct)
|
|
14244
14185
|
|
|
14245
|
-
|
|
14186
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
14246
14187
|
- eq or empty => equal
|
|
14247
14188
|
- gt => greater than
|
|
14248
14189
|
- ge => greater or equal
|
|
@@ -14254,7 +14195,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
14254
14195
|
- in => inside array separated by "|"
|
|
14255
14196
|
- nin => not inside array separated by "|"
|
|
14256
14197
|
|
|
14257
|
-
|
|
14198
|
+
Accepted parameters:
|
|
14258
14199
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
14259
14200
|
- fromRecord : initial record in query
|
|
14260
14201
|
|
|
@@ -14371,9 +14312,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
14371
14312
|
<Info>
|
|
14372
14313
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
14373
14314
|
|
|
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:
|
|
14315
|
+
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
14316
|
|
|
14378
14317
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
14379
14318
|
|
|
@@ -14381,7 +14320,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
14381
14320
|
|
|
14382
14321
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
14383
14322
|
</Info>
|
|
14384
|
-
|
|
14323
|
+
Accepted field names:
|
|
14385
14324
|
|
|
14386
14325
|
- `status` (eq, ne, ct, nct, sw, ew)
|
|
14387
14326
|
- `createdAt` (gt, ge, lt, le, eq, ne)
|
|
@@ -14402,7 +14341,7 @@ List of field names accepted:
|
|
|
14402
14341
|
- `paypointId` (eq, ne, gt, ge, lt, le)
|
|
14403
14342
|
- `cardType` (eq, ne, gt, ge, lt, le)
|
|
14404
14343
|
|
|
14405
|
-
|
|
14344
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
14406
14345
|
|
|
14407
14346
|
- eq or empty => equal
|
|
14408
14347
|
- gt => greater than
|
|
@@ -14521,9 +14460,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
14521
14460
|
<Info>
|
|
14522
14461
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
14523
14462
|
|
|
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:
|
|
14463
|
+
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
14464
|
|
|
14528
14465
|
--url https://api-sandbox.payabli.com/api/Query/vcardsTransactions/8cfec329267?parameters=transactionAmount(gt)=100&limitRecord=20
|
|
14529
14466
|
|
|
@@ -14532,7 +14469,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
14532
14469
|
--url https://api-sandbox.payabli.com/api/Query/vcardsTransactions/8cfec329267?transactionAmount(gt)=100&limitRecord=20
|
|
14533
14470
|
</Info>
|
|
14534
14471
|
|
|
14535
|
-
|
|
14472
|
+
Accepted field names:
|
|
14536
14473
|
|
|
14537
14474
|
- `identifier` (eq, ne, ct, nct)
|
|
14538
14475
|
- `transactionType` (eq, ne, ct, nct)
|
|
@@ -14557,7 +14494,7 @@ List of field names accepted:
|
|
|
14557
14494
|
- `externalPaypointID` (ct, nct, eq, ne)
|
|
14558
14495
|
- `paypointId` (gt, lt, eq, ne)
|
|
14559
14496
|
|
|
14560
|
-
|
|
14497
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
14561
14498
|
|
|
14562
14499
|
- eq or empty => equal
|
|
14563
14500
|
- gt => greater than
|
|
@@ -14674,9 +14611,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
14674
14611
|
<Info>
|
|
14675
14612
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
14676
14613
|
|
|
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:
|
|
14614
|
+
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
14615
|
|
|
14681
14616
|
--url https://api-sandbox.payabli.com/api/Query/vcardsTransactions/org/236?parameters=transactionAmount(gt)=100&limitRecord=20
|
|
14682
14617
|
|
|
@@ -14685,7 +14620,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
14685
14620
|
--url https://api-sandbox.payabli.com/api/Query/vcardsTransactions/org/236?transactionAmount(gt)=100&limitRecord=20
|
|
14686
14621
|
</Info>
|
|
14687
14622
|
|
|
14688
|
-
|
|
14623
|
+
Accepted field names:
|
|
14689
14624
|
|
|
14690
14625
|
- `identifier` (eq, ne, ct, nct)
|
|
14691
14626
|
- `transactionType` (eq, ne, ct, nct)
|
|
@@ -14710,7 +14645,7 @@ List of field names accepted:
|
|
|
14710
14645
|
- `externalPaypointID` (ct, nct, eq, ne)
|
|
14711
14646
|
- `paypointId` (gt, lt, eq, ne)
|
|
14712
14647
|
|
|
14713
|
-
|
|
14648
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
14714
14649
|
|
|
14715
14650
|
- eq or empty => equal
|
|
14716
14651
|
- gt => greater than
|
|
@@ -14834,9 +14769,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
14834
14769
|
<Info>
|
|
14835
14770
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
14836
14771
|
|
|
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:
|
|
14772
|
+
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
14773
|
|
|
14841
14774
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
14842
14775
|
|
|
@@ -14844,7 +14777,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
14844
14777
|
|
|
14845
14778
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
14846
14779
|
</Info>
|
|
14847
|
-
|
|
14780
|
+
Accepted field names:
|
|
14848
14781
|
|
|
14849
14782
|
- `status` (eq, ne, ct, nct, sw, ew)
|
|
14850
14783
|
- `createdAt` (gt, ge, lt, le, eq, ne)
|
|
@@ -14865,7 +14798,7 @@ List of field names accepted:
|
|
|
14865
14798
|
- `paypointId` (eq, ne, gt, ge, lt, le)
|
|
14866
14799
|
- `cardType` (eq, ne, gt, ge, lt, le)
|
|
14867
14800
|
|
|
14868
|
-
|
|
14801
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
14869
14802
|
|
|
14870
14803
|
- eq or empty => equal
|
|
14871
14804
|
- gt => greater than
|
|
@@ -15369,8 +15302,8 @@ client.notificationlogs.bulk_retry_notification_logs(request: %w[550e8400-e29b-4
|
|
|
15369
15302
|
</dl>
|
|
15370
15303
|
</details>
|
|
15371
15304
|
|
|
15372
|
-
##
|
|
15373
|
-
<details><summary><code>client.
|
|
15305
|
+
## Device
|
|
15306
|
+
<details><summary><code>client.device.<a href="/lib/payabli/device/client.rb">challenge</a>(entry:) -> Payabli::Types::DeviceChallengeResponse</code></summary>
|
|
15374
15307
|
<dl>
|
|
15375
15308
|
<dd>
|
|
15376
15309
|
|
|
@@ -15382,7 +15315,16 @@ client.notificationlogs.bulk_retry_notification_logs(request: %w[550e8400-e29b-4
|
|
|
15382
15315
|
<dl>
|
|
15383
15316
|
<dd>
|
|
15384
15317
|
|
|
15385
|
-
|
|
15318
|
+
Generates a one-time, 6-digit verification code for activating a
|
|
15319
|
+
semi-integrated card-present device in a paypoint. After calling this endpoint, an operator enters the returned code
|
|
15320
|
+
on the device's terminal, along with a device name, to register the
|
|
15321
|
+
device to the paypoint resolved from `{entry}`.
|
|
15322
|
+
|
|
15323
|
+
A code expires 5 minutes after it's issued. A paypoint can have several
|
|
15324
|
+
codes active at once — for example, when activating a batch of devices —
|
|
15325
|
+
and a code binds to whichever device enters it first.
|
|
15326
|
+
|
|
15327
|
+
Authenticate with an OAuth2 Bearer token that has the `device_registry` scope.
|
|
15386
15328
|
</dd>
|
|
15387
15329
|
</dl>
|
|
15388
15330
|
</dd>
|
|
@@ -15397,11 +15339,7 @@ Register a cloud device to an entrypoint. See [Devices Quickstart](/developers/d
|
|
|
15397
15339
|
<dd>
|
|
15398
15340
|
|
|
15399
15341
|
```ruby
|
|
15400
|
-
client.
|
|
15401
|
-
entry: "8cfec329267",
|
|
15402
|
-
description: "Front Desk POS",
|
|
15403
|
-
registration_code: "YS7DS5"
|
|
15404
|
-
)
|
|
15342
|
+
client.device.challenge(entry: "8cfec329267")
|
|
15405
15343
|
```
|
|
15406
15344
|
</dd>
|
|
15407
15345
|
</dl>
|
|
@@ -15424,37 +15362,7 @@ client.cloud.add_device(
|
|
|
15424
15362
|
<dl>
|
|
15425
15363
|
<dd>
|
|
15426
15364
|
|
|
15427
|
-
**
|
|
15428
|
-
|
|
15429
|
-
</dd>
|
|
15430
|
-
</dl>
|
|
15431
|
-
|
|
15432
|
-
<dl>
|
|
15433
|
-
<dd>
|
|
15434
|
-
|
|
15435
|
-
**description:** `String` — Description or name for the device. This can be anything, but Payabli recommends entering the name of the paypoint, or some other easy to identify descriptor. If you have several devices for one paypoint, you can give them descriptions like "Cashier 1" and "Cashier 2", or "Front Desk" and "Back Office"
|
|
15436
|
-
|
|
15437
|
-
</dd>
|
|
15438
|
-
</dl>
|
|
15439
|
-
|
|
15440
|
-
<dl>
|
|
15441
|
-
<dd>
|
|
15442
|
-
|
|
15443
|
-
**registration_code:** `String`
|
|
15444
|
-
|
|
15445
|
-
The device registration code or serial number, depending on the model.
|
|
15446
|
-
|
|
15447
|
-
- Ingenico devices: This is the activation code that's displayed on the device screen during setup.
|
|
15448
|
-
|
|
15449
|
-
- PAX A920 device: This code is the serial number on the back of the device.
|
|
15450
|
-
|
|
15451
|
-
</dd>
|
|
15452
|
-
</dl>
|
|
15453
|
-
|
|
15454
|
-
<dl>
|
|
15455
|
-
<dd>
|
|
15456
|
-
|
|
15457
|
-
**request_options:** `Payabli::Cloud::RequestOptions`
|
|
15365
|
+
**request_options:** `Payabli::Device::RequestOptions`
|
|
15458
15366
|
|
|
15459
15367
|
</dd>
|
|
15460
15368
|
</dl>
|
|
@@ -15466,7 +15374,8 @@ The device registration code or serial number, depending on the model.
|
|
|
15466
15374
|
</dl>
|
|
15467
15375
|
</details>
|
|
15468
15376
|
|
|
15469
|
-
|
|
15377
|
+
## Cloud
|
|
15378
|
+
<details><summary><code>client.cloud.<a href="/lib/payabli/cloud/client.rb">add_device</a>(entry:, request) -> Payabli::Types::AddDeviceResponse</code></summary>
|
|
15470
15379
|
<dl>
|
|
15471
15380
|
<dd>
|
|
15472
15381
|
|
|
@@ -15478,7 +15387,7 @@ The device registration code or serial number, depending on the model.
|
|
|
15478
15387
|
<dl>
|
|
15479
15388
|
<dd>
|
|
15480
15389
|
|
|
15481
|
-
|
|
15390
|
+
Register a cloud device to an entrypoint. See [Devices Quickstart](/developers/developer-guides/devices-quickstart#devices-quickstart) for a complete guide.
|
|
15482
15391
|
</dd>
|
|
15483
15392
|
</dl>
|
|
15484
15393
|
</dd>
|
|
@@ -15493,9 +15402,10 @@ Remove a cloud device from an entrypoint.
|
|
|
15493
15402
|
<dd>
|
|
15494
15403
|
|
|
15495
15404
|
```ruby
|
|
15496
|
-
client.cloud.
|
|
15405
|
+
client.cloud.add_device(
|
|
15497
15406
|
entry: "8cfec329267",
|
|
15498
|
-
|
|
15407
|
+
description: "Front Desk POS",
|
|
15408
|
+
registration_code: "YS7DS5"
|
|
15499
15409
|
)
|
|
15500
15410
|
```
|
|
15501
15411
|
</dd>
|
|
@@ -15519,7 +15429,7 @@ client.cloud.remove_device(
|
|
|
15519
15429
|
<dl>
|
|
15520
15430
|
<dd>
|
|
15521
15431
|
|
|
15522
|
-
**
|
|
15432
|
+
**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.
|
|
15523
15433
|
|
|
15524
15434
|
</dd>
|
|
15525
15435
|
</dl>
|
|
@@ -15527,12 +15437,107 @@ client.cloud.remove_device(
|
|
|
15527
15437
|
<dl>
|
|
15528
15438
|
<dd>
|
|
15529
15439
|
|
|
15530
|
-
**
|
|
15440
|
+
**description:** `String` — Description or name for the device. This can be anything, but Payabli recommends entering the name of the paypoint, or some other easy to identify descriptor. If you have several devices for one paypoint, you can give them descriptions like "Cashier 1" and "Cashier 2", or "Front Desk" and "Back Office"
|
|
15531
15441
|
|
|
15532
15442
|
</dd>
|
|
15533
15443
|
</dl>
|
|
15534
|
-
|
|
15535
|
-
|
|
15444
|
+
|
|
15445
|
+
<dl>
|
|
15446
|
+
<dd>
|
|
15447
|
+
|
|
15448
|
+
**registration_code:** `String`
|
|
15449
|
+
|
|
15450
|
+
The device registration code or serial number, depending on the model.
|
|
15451
|
+
|
|
15452
|
+
- Ingenico devices: This is the activation code that's displayed on the device screen during setup.
|
|
15453
|
+
|
|
15454
|
+
- PAX A920 device: This code is the serial number on the back of the device.
|
|
15455
|
+
|
|
15456
|
+
</dd>
|
|
15457
|
+
</dl>
|
|
15458
|
+
|
|
15459
|
+
<dl>
|
|
15460
|
+
<dd>
|
|
15461
|
+
|
|
15462
|
+
**request_options:** `Payabli::Cloud::RequestOptions`
|
|
15463
|
+
|
|
15464
|
+
</dd>
|
|
15465
|
+
</dl>
|
|
15466
|
+
</dd>
|
|
15467
|
+
</dl>
|
|
15468
|
+
|
|
15469
|
+
|
|
15470
|
+
</dd>
|
|
15471
|
+
</dl>
|
|
15472
|
+
</details>
|
|
15473
|
+
|
|
15474
|
+
<details><summary><code>client.cloud.<a href="/lib/payabli/cloud/client.rb">remove_device</a>(entry:, device_id:) -> Payabli::Types::RemoveDeviceResponse</code></summary>
|
|
15475
|
+
<dl>
|
|
15476
|
+
<dd>
|
|
15477
|
+
|
|
15478
|
+
#### 📝 Description
|
|
15479
|
+
|
|
15480
|
+
<dl>
|
|
15481
|
+
<dd>
|
|
15482
|
+
|
|
15483
|
+
<dl>
|
|
15484
|
+
<dd>
|
|
15485
|
+
|
|
15486
|
+
Remove a cloud device from an entrypoint.
|
|
15487
|
+
</dd>
|
|
15488
|
+
</dl>
|
|
15489
|
+
</dd>
|
|
15490
|
+
</dl>
|
|
15491
|
+
|
|
15492
|
+
#### 🔌 Usage
|
|
15493
|
+
|
|
15494
|
+
<dl>
|
|
15495
|
+
<dd>
|
|
15496
|
+
|
|
15497
|
+
<dl>
|
|
15498
|
+
<dd>
|
|
15499
|
+
|
|
15500
|
+
```ruby
|
|
15501
|
+
client.cloud.remove_device(
|
|
15502
|
+
entry: "8cfec329267",
|
|
15503
|
+
device_id: "499585-389fj484-3jcj8hj3"
|
|
15504
|
+
)
|
|
15505
|
+
```
|
|
15506
|
+
</dd>
|
|
15507
|
+
</dl>
|
|
15508
|
+
</dd>
|
|
15509
|
+
</dl>
|
|
15510
|
+
|
|
15511
|
+
#### ⚙️ Parameters
|
|
15512
|
+
|
|
15513
|
+
<dl>
|
|
15514
|
+
<dd>
|
|
15515
|
+
|
|
15516
|
+
<dl>
|
|
15517
|
+
<dd>
|
|
15518
|
+
|
|
15519
|
+
**entry:** `String` — The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
15520
|
+
|
|
15521
|
+
</dd>
|
|
15522
|
+
</dl>
|
|
15523
|
+
|
|
15524
|
+
<dl>
|
|
15525
|
+
<dd>
|
|
15526
|
+
|
|
15527
|
+
**device_id:** `String` — ID of the cloud device.
|
|
15528
|
+
|
|
15529
|
+
</dd>
|
|
15530
|
+
</dl>
|
|
15531
|
+
|
|
15532
|
+
<dl>
|
|
15533
|
+
<dd>
|
|
15534
|
+
|
|
15535
|
+
**request_options:** `Payabli::Cloud::RequestOptions`
|
|
15536
|
+
|
|
15537
|
+
</dd>
|
|
15538
|
+
</dl>
|
|
15539
|
+
</dd>
|
|
15540
|
+
</dl>
|
|
15536
15541
|
|
|
15537
15542
|
|
|
15538
15543
|
</dd>
|
|
@@ -15624,7 +15629,7 @@ client.cloud.history_device(
|
|
|
15624
15629
|
<dl>
|
|
15625
15630
|
<dd>
|
|
15626
15631
|
|
|
15627
|
-
Use [List devices by paypoint](/developers/api-reference/
|
|
15632
|
+
Use [List devices by paypoint](/developers/api-reference/get-list-of-devices-for-a-paypoint) instead, which supports filters, sorting, and pagination.
|
|
15628
15633
|
|
|
15629
15634
|
Get a list of cloud devices registered to an entrypoint.
|
|
15630
15635
|
</dd>
|
|
@@ -16048,9 +16053,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
16048
16053
|
<Info>
|
|
16049
16054
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
16050
16055
|
|
|
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:
|
|
16056
|
+
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
16057
|
|
|
16055
16058
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
16056
16059
|
|
|
@@ -16061,7 +16064,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
16061
16064
|
</Info>
|
|
16062
16065
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
16063
16066
|
|
|
16064
|
-
|
|
16067
|
+
**Accepted field names:**
|
|
16065
16068
|
|
|
16066
16069
|
- `categories` (ct, nct)
|
|
16067
16070
|
- `code` (ne, eq, ct, nct)
|
|
@@ -16080,7 +16083,7 @@ List of field names accepted:
|
|
|
16080
16083
|
- `updatedDate` (gt, ge, lt, le, eq, ne)
|
|
16081
16084
|
- `value` (gt, ge, lt, le, eq, ne)
|
|
16082
16085
|
|
|
16083
|
-
|
|
16086
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
16084
16087
|
|
|
16085
16088
|
- eq or empty => equal
|
|
16086
16089
|
- gt => greater than
|
|
@@ -16093,7 +16096,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
16093
16096
|
- in => inside array separated by "|"
|
|
16094
16097
|
- nin => not inside array separated by "|"
|
|
16095
16098
|
|
|
16096
|
-
|
|
16099
|
+
Accepted parameters:
|
|
16097
16100
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
16098
16101
|
- fromRecord : initial record in query
|
|
16099
16102
|
|
|
@@ -16937,7 +16940,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
16937
16940
|
|
|
16938
16941
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
16939
16942
|
|
|
16940
|
-
|
|
16943
|
+
Accepted field names:
|
|
16941
16944
|
- `createdAt` (gt, ge, lt, le, eq, ne)
|
|
16942
16945
|
- `startDate` (gt, ge, lt, le, eq, ne)
|
|
16943
16946
|
- `dbaname` (ct, nct)
|
|
@@ -16957,7 +16960,7 @@ List of field names accepted:
|
|
|
16957
16960
|
- `repCode` (ct, nct, eq, ne)
|
|
16958
16961
|
- `repName` (ct, nct, eq, ne)
|
|
16959
16962
|
- `repOffice` (ct, nct, eq, ne)
|
|
16960
|
-
|
|
16963
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
16961
16964
|
- eq or empty => equal
|
|
16962
16965
|
- gt => greater than
|
|
16963
16966
|
- ge => greater or equal
|
|
@@ -17072,7 +17075,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
17072
17075
|
|
|
17073
17076
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
17074
17077
|
|
|
17075
|
-
|
|
17078
|
+
Accepted field names:
|
|
17076
17079
|
- `lastUpdated` (gt, ge, lt, le, eq, ne)
|
|
17077
17080
|
- `templateName` (ct, nct)
|
|
17078
17081
|
- `referenceName` (ct, nct)
|
|
@@ -17082,7 +17085,7 @@ List of field names accepted:
|
|
|
17082
17085
|
- `templateId` (eq, ne)
|
|
17083
17086
|
- `orgParentname` (ct, nct)
|
|
17084
17087
|
|
|
17085
|
-
|
|
17088
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
17086
17089
|
- eq or empty => equal
|
|
17087
17090
|
- gt => greater than
|
|
17088
17091
|
- ge => greater or equal
|
|
@@ -17094,7 +17097,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
17094
17097
|
- in => inside array
|
|
17095
17098
|
- nin => not inside array
|
|
17096
17099
|
|
|
17097
|
-
|
|
17100
|
+
Accepted parameters:
|
|
17098
17101
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
17099
17102
|
- fromRecord : initial record in query
|
|
17100
17103
|
|
|
@@ -17564,9 +17567,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
17564
17567
|
<Info>
|
|
17565
17568
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
17566
17569
|
|
|
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:
|
|
17570
|
+
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
17571
|
|
|
17571
17572
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
17572
17573
|
|
|
@@ -17578,14 +17579,14 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
17578
17579
|
|
|
17579
17580
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
17580
17581
|
|
|
17581
|
-
|
|
17582
|
+
**Accepted field names:**
|
|
17582
17583
|
- `createdAt` (gt, ge, lt, le, eq, ne)
|
|
17583
17584
|
- `title` (ct, nct)
|
|
17584
17585
|
- `description` (ct, nct)
|
|
17585
17586
|
- `code` (ct, nct)
|
|
17586
17587
|
- `orgParentname` (ct, nct)
|
|
17587
17588
|
|
|
17588
|
-
|
|
17589
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
17589
17590
|
- eq or empty => equal
|
|
17590
17591
|
- gt => greater than
|
|
17591
17592
|
- ge => greater or equal
|
|
@@ -17597,7 +17598,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
17597
17598
|
- in => inside array
|
|
17598
17599
|
- nin => not inside array
|
|
17599
17600
|
|
|
17600
|
-
|
|
17601
|
+
Accepted parameters:
|
|
17601
17602
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
17602
17603
|
- fromRecord : initial record in query
|
|
17603
17604
|
|
|
@@ -17729,9 +17730,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
17729
17730
|
<Info>
|
|
17730
17731
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
17731
17732
|
|
|
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:
|
|
17733
|
+
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
17734
|
|
|
17736
17735
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
17737
17736
|
|
|
@@ -17742,7 +17741,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
17742
17741
|
|
|
17743
17742
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
17744
17743
|
|
|
17745
|
-
|
|
17744
|
+
**Accepted field names:**
|
|
17746
17745
|
- `createdAt` (gt, ge, lt, le, eq, ne)
|
|
17747
17746
|
- `startDate` (gt, ge, lt, le, eq, ne)
|
|
17748
17747
|
- `dbaname` (ct, nct)
|
|
@@ -17759,7 +17758,7 @@ List of field names accepted:
|
|
|
17759
17758
|
- `status` (eq, ne)
|
|
17760
17759
|
- `orgParentname` (ct, nct)
|
|
17761
17760
|
|
|
17762
|
-
|
|
17761
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
17763
17762
|
- eq or empty => equal
|
|
17764
17763
|
- gt => greater than
|
|
17765
17764
|
- ge => greater or equal
|
|
@@ -17771,7 +17770,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
17771
17770
|
- in => inside array
|
|
17772
17771
|
- nin => not inside array
|
|
17773
17772
|
|
|
17774
|
-
|
|
17773
|
+
Accepted parameters:
|
|
17775
17774
|
- `limitRecord` : max number of records for query (default="20", "0" or negative value for all)
|
|
17776
17775
|
- `fromRecord` : initial record in query
|
|
17777
17776
|
|
|
@@ -17894,9 +17893,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
17894
17893
|
<Info>
|
|
17895
17894
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
17896
17895
|
|
|
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:
|
|
17896
|
+
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
17897
|
|
|
17901
17898
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
17902
17899
|
|
|
@@ -17907,7 +17904,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
17907
17904
|
|
|
17908
17905
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
17909
17906
|
|
|
17910
|
-
**
|
|
17907
|
+
**Accepted field names:**
|
|
17911
17908
|
|
|
17912
17909
|
- `settlementDate` (gt, ge, lt, le, eq, ne)
|
|
17913
17910
|
- `depositDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -17947,7 +17944,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
17947
17944
|
- `batchId` (ct, nct, eq, neq)
|
|
17948
17945
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
17949
17946
|
|
|
17950
|
-
|
|
17947
|
+
Accepted parameters:
|
|
17951
17948
|
- limitRecord: max number of records for query (default="20", "0" or negative value for all)
|
|
17952
17949
|
- fromRecord: initial record in query
|
|
17953
17950
|
|
|
@@ -18070,9 +18067,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
18070
18067
|
<Info>
|
|
18071
18068
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
18072
18069
|
|
|
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:
|
|
18070
|
+
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
18071
|
|
|
18077
18072
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
18078
18073
|
|
|
@@ -18083,7 +18078,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
18083
18078
|
|
|
18084
18079
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
18085
18080
|
|
|
18086
|
-
**
|
|
18081
|
+
**Accepted field names:**
|
|
18087
18082
|
|
|
18088
18083
|
- `settlementDate` (gt, ge, lt, le, eq, ne)
|
|
18089
18084
|
- `depositDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -18123,7 +18118,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
18123
18118
|
- `batchId` (ct, nct, eq, neq)
|
|
18124
18119
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
18125
18120
|
|
|
18126
|
-
|
|
18121
|
+
Accepted parameters:
|
|
18127
18122
|
- limitRecord: max number of records for query (default="20", "0" or negative value for all)
|
|
18128
18123
|
- fromRecord: initial record in query
|
|
18129
18124
|
|
|
@@ -18246,9 +18241,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
18246
18241
|
<Info>
|
|
18247
18242
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
18248
18243
|
|
|
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:
|
|
18244
|
+
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
18245
|
|
|
18253
18246
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
18254
18247
|
|
|
@@ -18259,7 +18252,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
18259
18252
|
|
|
18260
18253
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
18261
18254
|
|
|
18262
|
-
|
|
18255
|
+
**Accepted field names:**
|
|
18263
18256
|
- `batchDate` (gt, ge, lt, le, eq, ne)
|
|
18264
18257
|
- `batchNumber` (ne, eq)
|
|
18265
18258
|
- `connectorName` (ne, eq, ct, nct)
|
|
@@ -18289,7 +18282,7 @@ List of field names accepted:
|
|
|
18289
18282
|
- `processor` (ne, eq, ct, nct)
|
|
18290
18283
|
- `transferStatus` (ne, eq, in, nin)
|
|
18291
18284
|
|
|
18292
|
-
|
|
18285
|
+
Accepted parameters:
|
|
18293
18286
|
- limitRecord: max number of records for query (default="20", "0" or negative value for all)
|
|
18294
18287
|
- fromRecord: initial record in query
|
|
18295
18288
|
|
|
@@ -18412,9 +18405,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
18412
18405
|
<Info>
|
|
18413
18406
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
18414
18407
|
|
|
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:
|
|
18408
|
+
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
18409
|
|
|
18419
18410
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
18420
18411
|
|
|
@@ -18424,7 +18415,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
18424
18415
|
</Info>
|
|
18425
18416
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
18426
18417
|
|
|
18427
|
-
|
|
18418
|
+
**Accepted field names:**
|
|
18428
18419
|
- `batchDate` (gt, ge, lt, le, eq, ne)
|
|
18429
18420
|
- `batchNumber` (ne, eq)
|
|
18430
18421
|
- `connectorName` (ne, eq, ct, nct)
|
|
@@ -18454,7 +18445,7 @@ List of field names accepted:
|
|
|
18454
18445
|
- `processor` (ne, eq, ct, nct)
|
|
18455
18446
|
- `transferStatus` (ne, eq, in, nin)
|
|
18456
18447
|
|
|
18457
|
-
|
|
18448
|
+
Accepted parameters:
|
|
18458
18449
|
- `limitRecord`: max number of records for query (default="20", "0" or negative value for all)
|
|
18459
18450
|
- `fromRecord`: initial record in query
|
|
18460
18451
|
Example: `batchAmount(gt)=20` returns all records with a `batchAmount` greater than 20.00
|
|
@@ -18576,9 +18567,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
18576
18567
|
<Info>
|
|
18577
18568
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
18578
18569
|
|
|
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:
|
|
18570
|
+
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
18571
|
|
|
18583
18572
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
18584
18573
|
|
|
@@ -18589,7 +18578,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
18589
18578
|
|
|
18590
18579
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
18591
18580
|
|
|
18592
|
-
|
|
18581
|
+
**Accepted field names:**
|
|
18593
18582
|
- `batchDate` (gt, ge, lt, le, eq, ne)
|
|
18594
18583
|
- `batchNumber` (ne, eq)
|
|
18595
18584
|
- `batchAmount` (gt, ge, lt, le, eq, ne)
|
|
@@ -18599,7 +18588,7 @@ List of field names accepted:
|
|
|
18599
18588
|
- `orgName` (ne, eq, ct, nct, nin, in)
|
|
18600
18589
|
- `paypointId` (ne, eq)
|
|
18601
18590
|
- `externalPaypointID` (ct, nct, eq, ne)
|
|
18602
|
-
|
|
18591
|
+
Accepted parameters:
|
|
18603
18592
|
- limitRecord: max number of records for query (default="20", "0" or negative value for all)
|
|
18604
18593
|
- fromRecord: initial record in query
|
|
18605
18594
|
|
|
@@ -18722,9 +18711,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
18722
18711
|
<Info>
|
|
18723
18712
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
18724
18713
|
|
|
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:
|
|
18714
|
+
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
18715
|
|
|
18729
18716
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
18730
18717
|
|
|
@@ -18735,7 +18722,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
18735
18722
|
|
|
18736
18723
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
18737
18724
|
|
|
18738
|
-
|
|
18725
|
+
**Accepted field names:**
|
|
18739
18726
|
- `batchDate` (gt, ge, lt, le, eq, ne)
|
|
18740
18727
|
- `batchNumber` (ne, eq)
|
|
18741
18728
|
- `batchAmount` (gt, ge, lt, le, eq, ne)
|
|
@@ -18745,7 +18732,7 @@ List of field names accepted:
|
|
|
18745
18732
|
- `orgName` (ne, eq, ct, nct, nin, in)
|
|
18746
18733
|
- `paypointId` (ne, eq)
|
|
18747
18734
|
- `externalPaypointID` (ct, nct, eq, ne)
|
|
18748
|
-
|
|
18735
|
+
Accepted parameters:
|
|
18749
18736
|
- limitRecord: max number of records for query (default="20", "0" or negative value for all)
|
|
18750
18737
|
- fromRecord: initial record in query
|
|
18751
18738
|
|
|
@@ -18868,9 +18855,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
18868
18855
|
<Info>
|
|
18869
18856
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
18870
18857
|
|
|
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:
|
|
18858
|
+
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
18859
|
|
|
18875
18860
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
18876
18861
|
|
|
@@ -18881,7 +18866,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
18881
18866
|
|
|
18882
18867
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
18883
18868
|
|
|
18884
|
-
|
|
18869
|
+
**Accepted field names:**
|
|
18885
18870
|
- `status` (in, nin, eq, ne)
|
|
18886
18871
|
- `billNumber` (ct, nct, eq, ne)
|
|
18887
18872
|
- `billDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -18897,7 +18882,7 @@ List of field names accepted:
|
|
|
18897
18882
|
- `paypointDba` (ne, eq, ct, nct)
|
|
18898
18883
|
- `orgName` (ne, eq, ct, nct)
|
|
18899
18884
|
|
|
18900
|
-
|
|
18885
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
18901
18886
|
- eq or empty => equal
|
|
18902
18887
|
- gt => greater than
|
|
18903
18888
|
- ge => greater or equal
|
|
@@ -18909,7 +18894,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
18909
18894
|
- in => inside array separated by "|"
|
|
18910
18895
|
- nin => not inside array separated by "|"
|
|
18911
18896
|
|
|
18912
|
-
|
|
18897
|
+
Accepted parameters:
|
|
18913
18898
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
18914
18899
|
- fromRecord : initial record in query
|
|
18915
18900
|
|
|
@@ -19032,9 +19017,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
19032
19017
|
<Info>
|
|
19033
19018
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
19034
19019
|
|
|
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:
|
|
19020
|
+
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
19021
|
|
|
19039
19022
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
19040
19023
|
|
|
@@ -19045,7 +19028,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
19045
19028
|
|
|
19046
19029
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
19047
19030
|
|
|
19048
|
-
|
|
19031
|
+
**Accepted field names:**
|
|
19049
19032
|
- `status` (in, nin, eq, ne)
|
|
19050
19033
|
- `billNumber` (ct, nct, eq, ne)
|
|
19051
19034
|
- `billDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -19061,7 +19044,7 @@ List of field names accepted:
|
|
|
19061
19044
|
- `paypointDba` (ne, eq, ct, nct)
|
|
19062
19045
|
- `orgName` (ne, eq, ct, nct)
|
|
19063
19046
|
|
|
19064
|
-
|
|
19047
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
19065
19048
|
- eq or empty => equal
|
|
19066
19049
|
- gt => greater than
|
|
19067
19050
|
- ge => greater or equal
|
|
@@ -19073,7 +19056,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
19073
19056
|
- in => inside array separated by "|"
|
|
19074
19057
|
- nin => not inside array separated by "|"
|
|
19075
19058
|
|
|
19076
|
-
|
|
19059
|
+
Accepted parameters:
|
|
19077
19060
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
19078
19061
|
- fromRecord : initial record in query
|
|
19079
19062
|
|
|
@@ -19196,9 +19179,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
19196
19179
|
<Info>
|
|
19197
19180
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
19198
19181
|
|
|
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:
|
|
19182
|
+
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
19183
|
|
|
19203
19184
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
19204
19185
|
|
|
@@ -19209,7 +19190,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
19209
19190
|
|
|
19210
19191
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
19211
19192
|
|
|
19212
|
-
|
|
19193
|
+
**Accepted field names:**
|
|
19213
19194
|
- `chargebackDate` (gt, ge, lt, le, eq, ne)
|
|
19214
19195
|
- `transId` (ne, eq, ct, nct)
|
|
19215
19196
|
- `method` (in, nin, eq, ne)
|
|
@@ -19246,7 +19227,7 @@ List of field names accepted:
|
|
|
19246
19227
|
- `orgName` (ne, eq, ct, nct)
|
|
19247
19228
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
19248
19229
|
|
|
19249
|
-
|
|
19230
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
19250
19231
|
- eq or empty => equal
|
|
19251
19232
|
- gt => greater than
|
|
19252
19233
|
- ge => greater or equal
|
|
@@ -19258,7 +19239,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
19258
19239
|
- in => inside array separated by "|"
|
|
19259
19240
|
- nin => not inside array separated by "|"
|
|
19260
19241
|
|
|
19261
|
-
|
|
19242
|
+
Accepted parameters:
|
|
19262
19243
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
19263
19244
|
- fromRecord : initial record in query
|
|
19264
19245
|
|
|
@@ -19381,9 +19362,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
19381
19362
|
<Info>
|
|
19382
19363
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
19383
19364
|
|
|
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:
|
|
19365
|
+
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
19366
|
|
|
19388
19367
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
19389
19368
|
|
|
@@ -19394,7 +19373,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
19394
19373
|
|
|
19395
19374
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
19396
19375
|
|
|
19397
|
-
|
|
19376
|
+
**Accepted field names:**
|
|
19398
19377
|
- `chargebackDate` (gt, ge, lt, le, eq, ne)
|
|
19399
19378
|
- `transId` (ne, eq, ct, nct)
|
|
19400
19379
|
- `method` (in, nin, eq, ne)
|
|
@@ -19431,7 +19410,7 @@ List of field names accepted:
|
|
|
19431
19410
|
- `orgName` (ne, eq, ct, nct)
|
|
19432
19411
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
19433
19412
|
|
|
19434
|
-
|
|
19413
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
19435
19414
|
- eq or empty => equal
|
|
19436
19415
|
- gt => greater than
|
|
19437
19416
|
- ge => greater or equal
|
|
@@ -19443,7 +19422,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
19443
19422
|
- in => inside array separated by "|"
|
|
19444
19423
|
- nin => not inside array separated by "|"
|
|
19445
19424
|
|
|
19446
|
-
|
|
19425
|
+
Accepted parameters:
|
|
19447
19426
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
19448
19427
|
- fromRecord : initial record in query
|
|
19449
19428
|
|
|
@@ -19566,9 +19545,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
19566
19545
|
<Info>
|
|
19567
19546
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
19568
19547
|
|
|
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:
|
|
19548
|
+
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
19549
|
|
|
19573
19550
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
19574
19551
|
|
|
@@ -19579,7 +19556,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
19579
19556
|
|
|
19580
19557
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
19581
19558
|
|
|
19582
|
-
**
|
|
19559
|
+
**Accepted field names:**
|
|
19583
19560
|
- `createdDate` (gt, ge, lt, le, eq, ne)
|
|
19584
19561
|
- `customernumber` (ne, eq, ct, nct)
|
|
19585
19562
|
- `firstname` (ne, eq, ct, nct)
|
|
@@ -19608,7 +19585,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
19608
19585
|
- `paypointDba` (ne, eq, ct, nct)
|
|
19609
19586
|
- `orgName` (ne, eq, ct, nct)
|
|
19610
19587
|
|
|
19611
|
-
**
|
|
19588
|
+
**Accepted comparison operators - enclosed between parentheses:**
|
|
19612
19589
|
- eq or empty => equal
|
|
19613
19590
|
- gt => greater than
|
|
19614
19591
|
- ge => greater or equal
|
|
@@ -19620,7 +19597,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
19620
19597
|
- in => inside array separated by "|"
|
|
19621
19598
|
- nin => not inside array separated by "|"
|
|
19622
19599
|
|
|
19623
|
-
**
|
|
19600
|
+
**Accepted parameters:**
|
|
19624
19601
|
- limitRecord: max number of records for query (default="20", "0" or negative value for all)
|
|
19625
19602
|
- fromRecord: initial record in query
|
|
19626
19603
|
|
|
@@ -19744,9 +19721,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
19744
19721
|
<Info>
|
|
19745
19722
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
19746
19723
|
|
|
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:
|
|
19724
|
+
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
19725
|
|
|
19751
19726
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
19752
19727
|
|
|
@@ -19757,7 +19732,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
19757
19732
|
|
|
19758
19733
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
19759
19734
|
|
|
19760
|
-
**
|
|
19735
|
+
**Accepted field names:**
|
|
19761
19736
|
- `createdDate` (gt, ge, lt, le, eq, ne)
|
|
19762
19737
|
- `customernumber` (ne, eq, ct, nct)
|
|
19763
19738
|
- `firstname` (ne, eq, ct, nct)
|
|
@@ -19786,7 +19761,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
19786
19761
|
- `paypointDba` (ne, eq, ct, nct)
|
|
19787
19762
|
- `orgName` (ne, eq, ct, nct)
|
|
19788
19763
|
|
|
19789
|
-
**
|
|
19764
|
+
**Accepted comparison operators - enclosed between parentheses:**
|
|
19790
19765
|
- eq or empty => equal
|
|
19791
19766
|
- gt => greater than
|
|
19792
19767
|
- ge => greater or equal
|
|
@@ -19798,7 +19773,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
19798
19773
|
- in => inside array separated by "|"
|
|
19799
19774
|
- nin => not inside array separated by "|"
|
|
19800
19775
|
|
|
19801
|
-
**
|
|
19776
|
+
**Accepted parameters:**
|
|
19802
19777
|
- limitRecord: max number of records for query (default="20", "0" or negative value for all)
|
|
19803
19778
|
- fromRecord: initial record in query
|
|
19804
19779
|
|
|
@@ -19922,9 +19897,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
19922
19897
|
<Info>
|
|
19923
19898
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
19924
19899
|
|
|
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:
|
|
19900
|
+
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
19901
|
|
|
19929
19902
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
19930
19903
|
|
|
@@ -19935,7 +19908,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
19935
19908
|
|
|
19936
19909
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
19937
19910
|
|
|
19938
|
-
|
|
19911
|
+
**Accepted field names:**
|
|
19939
19912
|
- `invoiceDate` (gt, ge, lt, le, eq, ne)
|
|
19940
19913
|
- `dueDate` (gt, ge, lt, le, eq, ne)
|
|
19941
19914
|
- `sentDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -19975,7 +19948,7 @@ List of field names accepted:
|
|
|
19975
19948
|
- `orgName` (ne, eq, ct, nct)
|
|
19976
19949
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
19977
19950
|
|
|
19978
|
-
|
|
19951
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
19979
19952
|
- eq or empty => equal
|
|
19980
19953
|
- gt => greater than
|
|
19981
19954
|
- ge => greater or equal
|
|
@@ -19987,7 +19960,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
19987
19960
|
- in => inside array
|
|
19988
19961
|
- nin => not inside array
|
|
19989
19962
|
|
|
19990
|
-
|
|
19963
|
+
Accepted parameters:
|
|
19991
19964
|
- `limitRecord` : max number of records for query (default="20", "0" or negative value for all)
|
|
19992
19965
|
- `fromRecord` : initial record in query
|
|
19993
19966
|
|
|
@@ -20110,9 +20083,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
20110
20083
|
<Info>
|
|
20111
20084
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
20112
20085
|
|
|
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:
|
|
20086
|
+
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
20087
|
|
|
20117
20088
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
20118
20089
|
|
|
@@ -20123,7 +20094,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
20123
20094
|
|
|
20124
20095
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
20125
20096
|
|
|
20126
|
-
|
|
20097
|
+
**Accepted field names:**
|
|
20127
20098
|
- `invoiceDate` (gt, ge, lt, le, eq, ne)
|
|
20128
20099
|
- `dueDate` (gt, ge, lt, le, eq, ne)
|
|
20129
20100
|
- `sentDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -20163,7 +20134,7 @@ List of field names accepted:
|
|
|
20163
20134
|
- `orgName` (ne, eq, ct, nct)
|
|
20164
20135
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
20165
20136
|
|
|
20166
|
-
|
|
20137
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
20167
20138
|
- eq or empty => equal
|
|
20168
20139
|
- gt => greater than
|
|
20169
20140
|
- ge => greater or equal
|
|
@@ -20175,7 +20146,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
20175
20146
|
- in => inside array
|
|
20176
20147
|
- nin => not inside array
|
|
20177
20148
|
|
|
20178
|
-
|
|
20149
|
+
Accepted parameters:
|
|
20179
20150
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
20180
20151
|
- fromRecord : initial record in query
|
|
20181
20152
|
|
|
@@ -20298,9 +20269,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
20298
20269
|
<Info>
|
|
20299
20270
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
20300
20271
|
|
|
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:
|
|
20272
|
+
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
20273
|
|
|
20305
20274
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
20306
20275
|
|
|
@@ -20311,7 +20280,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
20311
20280
|
|
|
20312
20281
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
20313
20282
|
|
|
20314
|
-
|
|
20283
|
+
**Accepted field names:**
|
|
20315
20284
|
- `name` (ct, nct, eq, ne)
|
|
20316
20285
|
- `type` (ne, eq)
|
|
20317
20286
|
- `contactName` (ct, nct, eq, ne)
|
|
@@ -20326,7 +20295,7 @@ List of field names accepted:
|
|
|
20326
20295
|
- `hasBilling` any value greater than zero is taken as TRUE otherwise is FALSE
|
|
20327
20296
|
- `hasResidual` any value greater than zero is taken as TRUE otherwise is FALSE
|
|
20328
20297
|
|
|
20329
|
-
|
|
20298
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
20330
20299
|
- eq or empty => equal
|
|
20331
20300
|
- gt => greater than
|
|
20332
20301
|
- ge => greater or equal
|
|
@@ -20338,7 +20307,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
20338
20307
|
- in => inside array
|
|
20339
20308
|
- nin => not inside array
|
|
20340
20309
|
|
|
20341
|
-
|
|
20310
|
+
Accepted parameters:
|
|
20342
20311
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
20343
20312
|
- fromRecord : initial record in query
|
|
20344
20313
|
|
|
@@ -20461,9 +20430,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
20461
20430
|
<Info>
|
|
20462
20431
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
20463
20432
|
|
|
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:
|
|
20433
|
+
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
20434
|
|
|
20468
20435
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
20469
20436
|
|
|
@@ -20474,7 +20441,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
20474
20441
|
|
|
20475
20442
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
20476
20443
|
|
|
20477
|
-
|
|
20444
|
+
**Accepted field names:**
|
|
20478
20445
|
- `status` (in, nin, eq, ne)
|
|
20479
20446
|
- `transactionDate` (gt, ge, lt, le, eq, ne)
|
|
20480
20447
|
- `billNumber` (ct, nct)
|
|
@@ -20488,7 +20455,7 @@ List of field names accepted:
|
|
|
20488
20455
|
- `paypointDba` (ne, eq, ct, nct)
|
|
20489
20456
|
- `orgName` (ne, eq, ct, nct)
|
|
20490
20457
|
|
|
20491
|
-
|
|
20458
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
20492
20459
|
- eq or empty => equal
|
|
20493
20460
|
- gt => greater than
|
|
20494
20461
|
- ge => greater or equal
|
|
@@ -20500,7 +20467,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
20500
20467
|
- in => inside array separated by "|"
|
|
20501
20468
|
- nin => not inside array separated by "|"
|
|
20502
20469
|
|
|
20503
|
-
|
|
20470
|
+
Accepted parameters:
|
|
20504
20471
|
- limitRecord: max number of records for query (default="20", "0" or negative value for all)
|
|
20505
20472
|
- fromRecord: initial record in query
|
|
20506
20473
|
|
|
@@ -20623,9 +20590,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
20623
20590
|
<Info>
|
|
20624
20591
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
20625
20592
|
|
|
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:
|
|
20593
|
+
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
20594
|
|
|
20630
20595
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
20631
20596
|
|
|
@@ -20636,7 +20601,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
20636
20601
|
|
|
20637
20602
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
20638
20603
|
|
|
20639
|
-
|
|
20604
|
+
**Accepted field names:**
|
|
20640
20605
|
- `status` (in, nin, eq, ne)
|
|
20641
20606
|
- `transactionDate` (gt, ge, lt, le, eq, ne)
|
|
20642
20607
|
- `billNumber` (ct, nct)
|
|
@@ -20650,7 +20615,7 @@ List of field names accepted:
|
|
|
20650
20615
|
- `paypointDba` (ne, eq, ct, nct)
|
|
20651
20616
|
- `orgName` (ne, eq, ct, nct)
|
|
20652
20617
|
|
|
20653
|
-
|
|
20618
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
20654
20619
|
- eq or empty => equal
|
|
20655
20620
|
- gt => greater than
|
|
20656
20621
|
- ge => greater or equal
|
|
@@ -20662,7 +20627,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
20662
20627
|
- in => inside array separated by "|"
|
|
20663
20628
|
- nin => not inside array separated by "|"
|
|
20664
20629
|
|
|
20665
|
-
|
|
20630
|
+
Accepted parameters:
|
|
20666
20631
|
- limitRecord: max number of records for query (default="20", "0" or negative value for all)
|
|
20667
20632
|
- fromRecord: initial record in query
|
|
20668
20633
|
|
|
@@ -20785,9 +20750,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
20785
20750
|
<Info>
|
|
20786
20751
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
20787
20752
|
|
|
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:
|
|
20753
|
+
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
20754
|
|
|
20792
20755
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
20793
20756
|
|
|
@@ -20798,7 +20761,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
20798
20761
|
|
|
20799
20762
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
20800
20763
|
|
|
20801
|
-
|
|
20764
|
+
**Accepted field names:**
|
|
20802
20765
|
- `createdAt` (gt, ge, lt, le, eq, ne)
|
|
20803
20766
|
- `startDate` (gt, ge, lt, le, eq, ne)
|
|
20804
20767
|
- `dbaname` (ct, nct)
|
|
@@ -20814,7 +20777,7 @@ List of field names accepted:
|
|
|
20814
20777
|
- `contactName` (ct, nct)
|
|
20815
20778
|
- `orgParentname` (ct, nct)
|
|
20816
20779
|
|
|
20817
|
-
|
|
20780
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
20818
20781
|
- eq or empty => equal
|
|
20819
20782
|
- gt => greater than
|
|
20820
20783
|
- ge => greater or equal
|
|
@@ -20826,7 +20789,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
20826
20789
|
- in => inside array
|
|
20827
20790
|
- nin => not inside array
|
|
20828
20791
|
|
|
20829
|
-
|
|
20792
|
+
Accepted parameters:
|
|
20830
20793
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
20831
20794
|
- fromRecord : initial record in query
|
|
20832
20795
|
|
|
@@ -20949,9 +20912,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
20949
20912
|
<Info>
|
|
20950
20913
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
20951
20914
|
|
|
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:
|
|
20915
|
+
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
20916
|
|
|
20956
20917
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
20957
20918
|
|
|
@@ -20962,7 +20923,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
20962
20923
|
|
|
20963
20924
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
20964
20925
|
|
|
20965
|
-
|
|
20926
|
+
**Accepted field names:**
|
|
20966
20927
|
- `settlementDate` (gt, ge, lt, le, eq, ne)
|
|
20967
20928
|
- `transId` (ne, eq, ct, nct)
|
|
20968
20929
|
- `gatewayTransId` (ne, eq, ct, nct)
|
|
@@ -20998,7 +20959,7 @@ List of field names accepted:
|
|
|
20998
20959
|
- `orgName` (ne, eq, ct, nct)
|
|
20999
20960
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
21000
20961
|
|
|
21001
|
-
|
|
20962
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
21002
20963
|
- eq or empty => equal
|
|
21003
20964
|
- gt => greater than
|
|
21004
20965
|
- ge => greater or equal
|
|
@@ -21010,7 +20971,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
21010
20971
|
- in => inside array separated by "|"
|
|
21011
20972
|
- nin => not inside array separated by "|"
|
|
21012
20973
|
|
|
21013
|
-
|
|
20974
|
+
Accepted parameters:
|
|
21014
20975
|
- limitRecord: max number of records for query (default="20", "0" or negative value for all)
|
|
21015
20976
|
- fromRecord: initial record in query
|
|
21016
20977
|
|
|
@@ -21133,9 +21094,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
21133
21094
|
<Info>
|
|
21134
21095
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
21135
21096
|
|
|
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:
|
|
21097
|
+
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
21098
|
|
|
21140
21099
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
21141
21100
|
|
|
@@ -21146,7 +21105,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
21146
21105
|
|
|
21147
21106
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
21148
21107
|
|
|
21149
|
-
|
|
21108
|
+
**Accepted field names:**
|
|
21150
21109
|
- `settlementDate` (gt, ge, lt, le, eq, ne)
|
|
21151
21110
|
- `transId` (ne, eq, ct, nct)
|
|
21152
21111
|
- `gatewayTransId` (ne, eq, ct, nct)
|
|
@@ -21182,7 +21141,7 @@ List of field names accepted:
|
|
|
21182
21141
|
- `orgName` (ne, eq, ct, nct)
|
|
21183
21142
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
21184
21143
|
|
|
21185
|
-
|
|
21144
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
21186
21145
|
- eq or empty => equal
|
|
21187
21146
|
- gt => greater than
|
|
21188
21147
|
- ge => greater or equal
|
|
@@ -21194,7 +21153,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
21194
21153
|
- in => inside array separated by "|"
|
|
21195
21154
|
- nin => not inside array separated by "|"
|
|
21196
21155
|
|
|
21197
|
-
|
|
21156
|
+
Accepted parameters:
|
|
21198
21157
|
- limitRecord: max number of records for query (default="20", "0" or negative value for all)
|
|
21199
21158
|
- fromRecord: initial record in query
|
|
21200
21159
|
|
|
@@ -21317,9 +21276,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
21317
21276
|
<Info>
|
|
21318
21277
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
21319
21278
|
|
|
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:
|
|
21279
|
+
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
21280
|
|
|
21324
21281
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
21325
21282
|
|
|
@@ -21330,7 +21287,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
21330
21287
|
|
|
21331
21288
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
21332
21289
|
|
|
21333
|
-
|
|
21290
|
+
**Accepted field names:**
|
|
21334
21291
|
- `startDate` (gt, ge, lt, le, eq, ne)
|
|
21335
21292
|
- `endDate` (gt, ge, lt, le, eq, ne)
|
|
21336
21293
|
- `nextDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -21368,7 +21325,7 @@ List of field names accepted:
|
|
|
21368
21325
|
- `orgName` (ne, eq, ct, nct)
|
|
21369
21326
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
21370
21327
|
|
|
21371
|
-
|
|
21328
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
21372
21329
|
- eq or empty => equal
|
|
21373
21330
|
- gt => greater than
|
|
21374
21331
|
- ge => greater or equal
|
|
@@ -21380,7 +21337,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
21380
21337
|
- in => inside array
|
|
21381
21338
|
- nin => not inside array
|
|
21382
21339
|
|
|
21383
|
-
|
|
21340
|
+
Accepted parameters:
|
|
21384
21341
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
21385
21342
|
- fromRecord : initial record in query
|
|
21386
21343
|
|
|
@@ -21503,9 +21460,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
21503
21460
|
<Info>
|
|
21504
21461
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
21505
21462
|
|
|
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:
|
|
21463
|
+
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
21464
|
|
|
21510
21465
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
21511
21466
|
|
|
@@ -21516,7 +21471,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
21516
21471
|
|
|
21517
21472
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
21518
21473
|
|
|
21519
|
-
|
|
21474
|
+
**Accepted field names:**
|
|
21520
21475
|
- `startDate` (gt, ge, lt, le, eq, ne)
|
|
21521
21476
|
- `endDate` (gt, ge, lt, le, eq, ne)
|
|
21522
21477
|
- `nextDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -21554,7 +21509,7 @@ List of field names accepted:
|
|
|
21554
21509
|
- `orgName` (ne, eq, ct, nct)
|
|
21555
21510
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
21556
21511
|
|
|
21557
|
-
|
|
21512
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
21558
21513
|
- eq or empty => equal
|
|
21559
21514
|
- gt => greater than
|
|
21560
21515
|
- ge => greater or equal
|
|
@@ -21566,7 +21521,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
21566
21521
|
- in => inside array
|
|
21567
21522
|
- nin => not inside array
|
|
21568
21523
|
|
|
21569
|
-
|
|
21524
|
+
Accepted parameters:
|
|
21570
21525
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
21571
21526
|
- fromRecord : initial record in query
|
|
21572
21527
|
|
|
@@ -21689,9 +21644,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
21689
21644
|
<Info>
|
|
21690
21645
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
21691
21646
|
|
|
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:
|
|
21647
|
+
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
21648
|
|
|
21696
21649
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
21697
21650
|
|
|
@@ -21702,7 +21655,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
21702
21655
|
|
|
21703
21656
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
21704
21657
|
|
|
21705
|
-
|
|
21658
|
+
**Accepted field names:**
|
|
21706
21659
|
- `transactionDate` (gt, ge, lt, le, eq, ne)
|
|
21707
21660
|
- `transId` (ne, eq, ct, nct)
|
|
21708
21661
|
- `gatewayTransId` (ne, eq, ct, nct)
|
|
@@ -21744,7 +21697,7 @@ List of field names accepted:
|
|
|
21744
21697
|
- `customerShippingCountry` (ct, nct, eq, ne)
|
|
21745
21698
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
21746
21699
|
|
|
21747
|
-
|
|
21700
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
21748
21701
|
- eq or empty => equal
|
|
21749
21702
|
- gt => greater than
|
|
21750
21703
|
- ge => greater or equal
|
|
@@ -21756,7 +21709,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
21756
21709
|
- in => inside array
|
|
21757
21710
|
- nin => not inside array
|
|
21758
21711
|
|
|
21759
|
-
|
|
21712
|
+
Accepted parameters:
|
|
21760
21713
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
21761
21714
|
- fromRecord : initial record in query
|
|
21762
21715
|
|
|
@@ -21879,9 +21832,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
21879
21832
|
<Info>
|
|
21880
21833
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
21881
21834
|
|
|
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:
|
|
21835
|
+
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
21836
|
|
|
21886
21837
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
21887
21838
|
|
|
@@ -21892,7 +21843,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
21892
21843
|
|
|
21893
21844
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
21894
21845
|
|
|
21895
|
-
|
|
21846
|
+
**Accepted field names:**
|
|
21896
21847
|
- `transactionDate` (gt, ge, lt, le, eq, ne)
|
|
21897
21848
|
- `transId` (ne, eq, ct, nct)
|
|
21898
21849
|
- `gatewayTransId` (ne, eq, ct, nct)
|
|
@@ -21934,7 +21885,7 @@ List of field names accepted:
|
|
|
21934
21885
|
- `customerShippingCountry` (ct, nct, eq, ne)
|
|
21935
21886
|
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
21936
21887
|
|
|
21937
|
-
|
|
21888
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
21938
21889
|
- eq or empty => equal
|
|
21939
21890
|
- gt => greater than
|
|
21940
21891
|
- ge => greater or equal
|
|
@@ -21946,7 +21897,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
21946
21897
|
- in => inside array
|
|
21947
21898
|
- nin => not inside array
|
|
21948
21899
|
|
|
21949
|
-
|
|
21900
|
+
Accepted parameters:
|
|
21950
21901
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
21951
21902
|
- fromRecord : initial record in query
|
|
21952
21903
|
|
|
@@ -22079,9 +22030,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
22079
22030
|
<Info>
|
|
22080
22031
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
22081
22032
|
|
|
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:
|
|
22033
|
+
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
22034
|
|
|
22086
22035
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
22087
22036
|
|
|
@@ -22092,7 +22041,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
22092
22041
|
|
|
22093
22042
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
22094
22043
|
|
|
22095
|
-
|
|
22044
|
+
**Accepted field names:**
|
|
22096
22045
|
|
|
22097
22046
|
- `grossAmount` (gt, ge, lt, le, eq, ne)
|
|
22098
22047
|
|
|
@@ -22233,9 +22182,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
22233
22182
|
<Info>
|
|
22234
22183
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
22235
22184
|
|
|
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:
|
|
22185
|
+
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
22186
|
|
|
22240
22187
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
22241
22188
|
|
|
@@ -22246,7 +22193,7 @@ Collection of field names, conditions, and values used to filter the query
|
|
|
22246
22193
|
|
|
22247
22194
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
22248
22195
|
|
|
22249
|
-
|
|
22196
|
+
**Accepted field names:**
|
|
22250
22197
|
- `transferDate` (gt, ge, lt, le, eq, ne)
|
|
22251
22198
|
|
|
22252
22199
|
- `grossAmount` (gt, ge, lt, le, eq, ne)
|
|
@@ -22396,9 +22343,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
22396
22343
|
<Info>
|
|
22397
22344
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
22398
22345
|
|
|
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:
|
|
22346
|
+
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
22347
|
|
|
22403
22348
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
22404
22349
|
|
|
@@ -22409,7 +22354,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
22409
22354
|
|
|
22410
22355
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
22411
22356
|
|
|
22412
|
-
|
|
22357
|
+
**Accepted field names:**
|
|
22413
22358
|
- `method` (in, nin, eq, ne)
|
|
22414
22359
|
- `enrollmentStatus` (in, nin, eq, ne)
|
|
22415
22360
|
- `status` (in, nin, eq, ne)
|
|
@@ -22429,7 +22374,7 @@ List of field names accepted:
|
|
|
22429
22374
|
- `paypointDba` (ne, eq, ct, nct)
|
|
22430
22375
|
- `orgName` (ne, eq, ct, nct)
|
|
22431
22376
|
|
|
22432
|
-
|
|
22377
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
22433
22378
|
- eq or empty => equal
|
|
22434
22379
|
- gt => greater than
|
|
22435
22380
|
- ge => greater or equal
|
|
@@ -22441,7 +22386,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
22441
22386
|
- in => inside array separated by "|"
|
|
22442
22387
|
- nin => not inside array separated by "|"
|
|
22443
22388
|
|
|
22444
|
-
|
|
22389
|
+
Accepted parameters:
|
|
22445
22390
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
22446
22391
|
- fromRecord : initial record in query
|
|
22447
22392
|
|
|
@@ -22564,9 +22509,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
22564
22509
|
<Info>
|
|
22565
22510
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
22566
22511
|
|
|
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:
|
|
22512
|
+
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
22513
|
|
|
22571
22514
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
22572
22515
|
|
|
@@ -22577,7 +22520,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
22577
22520
|
|
|
22578
22521
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for help.
|
|
22579
22522
|
|
|
22580
|
-
|
|
22523
|
+
**Accepted field names:**
|
|
22581
22524
|
- `method` (in, nin, eq, ne)
|
|
22582
22525
|
- `enrollmentStatus` (in, nin, eq, ne)
|
|
22583
22526
|
- `status` (in, nin, eq, ne)
|
|
@@ -22597,7 +22540,7 @@ List of field names accepted:
|
|
|
22597
22540
|
- `paypointDba` (ne, eq, ct, nct)
|
|
22598
22541
|
- `orgName` (ne, eq, ct, nct)
|
|
22599
22542
|
|
|
22600
|
-
|
|
22543
|
+
Accepted comparison operators - enclosed between parentheses:
|
|
22601
22544
|
- eq or empty => equal
|
|
22602
22545
|
- gt => greater than
|
|
22603
22546
|
- ge => greater or equal
|
|
@@ -22609,7 +22552,7 @@ List of comparison accepted - enclosed between parentheses:
|
|
|
22609
22552
|
- in => inside array separated by "|"
|
|
22610
22553
|
- nin => not inside array separated by "|"
|
|
22611
22554
|
|
|
22612
|
-
|
|
22555
|
+
Accepted parameters:
|
|
22613
22556
|
- limitRecord : max number of records for query (default="20", "0" or negative value for all)
|
|
22614
22557
|
- fromRecord : initial record in query
|
|
22615
22558
|
|
|
@@ -22886,7 +22829,7 @@ client.organization.add_organization(
|
|
|
22886
22829
|
</dl>
|
|
22887
22830
|
</details>
|
|
22888
22831
|
|
|
22889
|
-
<details><summary><code>client.organization.<a href="/lib/payabli/organization/client.rb">edit_organization</a>(
|
|
22832
|
+
<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
22833
|
<dl>
|
|
22891
22834
|
<dd>
|
|
22892
22835
|
|
|
@@ -22914,7 +22857,7 @@ Updates an organization's details by ID.
|
|
|
22914
22857
|
|
|
22915
22858
|
```ruby
|
|
22916
22859
|
client.organization.edit_organization(
|
|
22917
|
-
|
|
22860
|
+
org_id_path_param: 123,
|
|
22918
22861
|
contacts: [{
|
|
22919
22862
|
contact_email: "herman@hermanscoatings.com",
|
|
22920
22863
|
contact_name: "Herman Martinez",
|
|
@@ -22925,7 +22868,7 @@ client.organization.edit_organization(
|
|
|
22925
22868
|
org_city: "Johnson City",
|
|
22926
22869
|
org_country: "US",
|
|
22927
22870
|
org_entry_name: "pilgrim-planner",
|
|
22928
|
-
|
|
22871
|
+
org_id: "123",
|
|
22929
22872
|
org_name: "Pilgrim Planner",
|
|
22930
22873
|
org_state: "TN",
|
|
22931
22874
|
org_timezone: -5,
|
|
@@ -22947,7 +22890,7 @@ client.organization.edit_organization(
|
|
|
22947
22890
|
<dl>
|
|
22948
22891
|
<dd>
|
|
22949
22892
|
|
|
22950
|
-
**
|
|
22893
|
+
**org_id_path_param:** `Integer` — The numeric identifier for organization, assigned by Payabli.
|
|
22951
22894
|
|
|
22952
22895
|
</dd>
|
|
22953
22896
|
</dl>
|
|
@@ -23027,7 +22970,7 @@ client.organization.edit_organization(
|
|
|
23027
22970
|
<dl>
|
|
23028
22971
|
<dd>
|
|
23029
22972
|
|
|
23030
|
-
**
|
|
22973
|
+
**org_id:** `String`
|
|
23031
22974
|
|
|
23032
22975
|
</dd>
|
|
23033
22976
|
</dl>
|
|
@@ -24053,7 +23996,7 @@ For example, `w` groups the results by week.
|
|
|
24053
23996
|
<dl>
|
|
24054
23997
|
<dd>
|
|
24055
23998
|
|
|
24056
|
-
Create a new notification or
|
|
23999
|
+
Create a new notification or autogenerated report.
|
|
24057
24000
|
</dd>
|
|
24058
24001
|
</dl>
|
|
24059
24002
|
</dd>
|
|
@@ -24125,7 +24068,7 @@ client.notification.add_notification(
|
|
|
24125
24068
|
<dl>
|
|
24126
24069
|
<dd>
|
|
24127
24070
|
|
|
24128
|
-
Retrieves a single notification or
|
|
24071
|
+
Retrieves a single notification or autogenerated report's details.
|
|
24129
24072
|
</dd>
|
|
24130
24073
|
</dl>
|
|
24131
24074
|
</dd>
|
|
@@ -24187,7 +24130,7 @@ client.notification.get_notification(n_id: "1717")
|
|
|
24187
24130
|
<dl>
|
|
24188
24131
|
<dd>
|
|
24189
24132
|
|
|
24190
|
-
Update a notification or
|
|
24133
|
+
Update a notification or autogenerated report.
|
|
24191
24134
|
</dd>
|
|
24192
24135
|
</dl>
|
|
24193
24136
|
</dd>
|
|
@@ -24268,7 +24211,7 @@ client.notification.update_notification(
|
|
|
24268
24211
|
<dl>
|
|
24269
24212
|
<dd>
|
|
24270
24213
|
|
|
24271
|
-
Deletes a single notification or
|
|
24214
|
+
Deletes a single notification or autogenerated report.
|
|
24272
24215
|
</dd>
|
|
24273
24216
|
</dl>
|
|
24274
24217
|
</dd>
|
|
@@ -26252,14 +26195,6 @@ client.money_out.authorize_out(
|
|
|
26252
26195
|
<dl>
|
|
26253
26196
|
<dd>
|
|
26254
26197
|
|
|
26255
|
-
**force_vendor_creation:** `Internal::Types::Boolean` — When `true`, the request creates a new vendor record, regardless of whether the vendor already exists.
|
|
26256
|
-
|
|
26257
|
-
</dd>
|
|
26258
|
-
</dl>
|
|
26259
|
-
|
|
26260
|
-
<dl>
|
|
26261
|
-
<dd>
|
|
26262
|
-
|
|
26263
26198
|
**same_day_ach:** `Internal::Types::Boolean`
|
|
26264
26199
|
|
|
26265
26200
|
When `true`, Payabli authorizes the payout for same-day ACH processing instead of standard ACH. Same-day ACH must be enabled for the paypoint, otherwise the authorization fails with a `400` response and `responseCode` `3492`. Only ACH payouts honor this flag. Wire and RTP payouts ignore it.
|
|
@@ -26336,7 +26271,7 @@ Same-day ACH has a daily cutoff. Capture the transaction before the cutoff, or p
|
|
|
26336
26271
|
<dl>
|
|
26337
26272
|
<dd>
|
|
26338
26273
|
|
|
26339
|
-
**invoice_data:** `Internal::Types::Array[Payabli::Types::RequestOutAuthorizeInvoiceData]` —
|
|
26274
|
+
**invoice_data:** `Internal::Types::Array[Payabli::Types::RequestOutAuthorizeInvoiceData]` — Bills to pay with this payout, each referenced by `billId`.
|
|
26340
26275
|
|
|
26341
26276
|
</dd>
|
|
26342
26277
|
</dl>
|
|
@@ -27283,7 +27218,7 @@ Deposits funds into a paypoint's available payout balance. Deposited funds enter
|
|
|
27283
27218
|
|
|
27284
27219
|
```ruby
|
|
27285
27220
|
client.funding.deposit_funds(
|
|
27286
|
-
amount:
|
|
27221
|
+
amount: 1500,
|
|
27287
27222
|
entrypoint: "48acde49",
|
|
27288
27223
|
account_id: "333"
|
|
27289
27224
|
)
|
|
@@ -29439,3 +29374,227 @@ client.case_management.delete_attachment(
|
|
|
29439
29374
|
</dl>
|
|
29440
29375
|
</details>
|
|
29441
29376
|
|
|
29377
|
+
## Billing
|
|
29378
|
+
<details><summary><code>client.billing.<a href="/lib/payabli/billing/client.rb">list_profiles</a>(org_id:) -> Payabli::Types::BillingProfileQueryResponse</code></summary>
|
|
29379
|
+
<dl>
|
|
29380
|
+
<dd>
|
|
29381
|
+
|
|
29382
|
+
#### 📝 Description
|
|
29383
|
+
|
|
29384
|
+
<dl>
|
|
29385
|
+
<dd>
|
|
29386
|
+
|
|
29387
|
+
<dl>
|
|
29388
|
+
<dd>
|
|
29389
|
+
|
|
29390
|
+
Returns every billing profile that belongs to an organization. This is
|
|
29391
|
+
the data behind the Profile Library table in the Payabli Portal.
|
|
29392
|
+
|
|
29393
|
+
Requires a token with the `billing_profile_read` permission; a token
|
|
29394
|
+
without it gets `403 Forbidden`.
|
|
29395
|
+
</dd>
|
|
29396
|
+
</dl>
|
|
29397
|
+
</dd>
|
|
29398
|
+
</dl>
|
|
29399
|
+
|
|
29400
|
+
#### 🔌 Usage
|
|
29401
|
+
|
|
29402
|
+
<dl>
|
|
29403
|
+
<dd>
|
|
29404
|
+
|
|
29405
|
+
<dl>
|
|
29406
|
+
<dd>
|
|
29407
|
+
|
|
29408
|
+
```ruby
|
|
29409
|
+
client.billing.list_profiles(
|
|
29410
|
+
org_id: 123,
|
|
29411
|
+
limit_record: 20,
|
|
29412
|
+
from_record: 0
|
|
29413
|
+
)
|
|
29414
|
+
```
|
|
29415
|
+
</dd>
|
|
29416
|
+
</dl>
|
|
29417
|
+
</dd>
|
|
29418
|
+
</dl>
|
|
29419
|
+
|
|
29420
|
+
#### ⚙️ Parameters
|
|
29421
|
+
|
|
29422
|
+
<dl>
|
|
29423
|
+
<dd>
|
|
29424
|
+
|
|
29425
|
+
<dl>
|
|
29426
|
+
<dd>
|
|
29427
|
+
|
|
29428
|
+
**org_id:** `Integer` — The organization's numeric identifier.
|
|
29429
|
+
|
|
29430
|
+
</dd>
|
|
29431
|
+
</dl>
|
|
29432
|
+
|
|
29433
|
+
<dl>
|
|
29434
|
+
<dd>
|
|
29435
|
+
|
|
29436
|
+
**profile_name:** `String` — Filter to profiles whose name contains this string.
|
|
29437
|
+
|
|
29438
|
+
</dd>
|
|
29439
|
+
</dl>
|
|
29440
|
+
|
|
29441
|
+
<dl>
|
|
29442
|
+
<dd>
|
|
29443
|
+
|
|
29444
|
+
**fee_type:** `Integer`
|
|
29445
|
+
|
|
29446
|
+
Filter by fee type. Repeatable to match more than one. Send the enum
|
|
29447
|
+
value (`1` Flat, `2` ICP).
|
|
29448
|
+
|
|
29449
|
+
</dd>
|
|
29450
|
+
</dl>
|
|
29451
|
+
|
|
29452
|
+
<dl>
|
|
29453
|
+
<dd>
|
|
29454
|
+
|
|
29455
|
+
**service_vertical:** `Integer`
|
|
29456
|
+
|
|
29457
|
+
Filter by billing vertical. Repeatable to match more than one. Send
|
|
29458
|
+
the enum value (`1` PayIn, `2` PayOut, `3` PayOps).
|
|
29459
|
+
|
|
29460
|
+
</dd>
|
|
29461
|
+
</dl>
|
|
29462
|
+
|
|
29463
|
+
<dl>
|
|
29464
|
+
<dd>
|
|
29465
|
+
|
|
29466
|
+
**profile_id:** `Integer` — Filter to a single profile by its identifier.
|
|
29467
|
+
|
|
29468
|
+
</dd>
|
|
29469
|
+
</dl>
|
|
29470
|
+
|
|
29471
|
+
<dl>
|
|
29472
|
+
<dd>
|
|
29473
|
+
|
|
29474
|
+
**limit_record:** `Integer`
|
|
29475
|
+
|
|
29476
|
+
Page size. Defaults to `20`. Passing `0` returns no records — use a
|
|
29477
|
+
positive value to page through results.
|
|
29478
|
+
|
|
29479
|
+
</dd>
|
|
29480
|
+
</dl>
|
|
29481
|
+
|
|
29482
|
+
<dl>
|
|
29483
|
+
<dd>
|
|
29484
|
+
|
|
29485
|
+
**from_record:** `Integer` — Zero-based offset into the result set. Defaults to `0`.
|
|
29486
|
+
|
|
29487
|
+
</dd>
|
|
29488
|
+
</dl>
|
|
29489
|
+
|
|
29490
|
+
<dl>
|
|
29491
|
+
<dd>
|
|
29492
|
+
|
|
29493
|
+
**request_options:** `Payabli::Billing::RequestOptions`
|
|
29494
|
+
|
|
29495
|
+
</dd>
|
|
29496
|
+
</dl>
|
|
29497
|
+
</dd>
|
|
29498
|
+
</dl>
|
|
29499
|
+
|
|
29500
|
+
|
|
29501
|
+
</dd>
|
|
29502
|
+
</dl>
|
|
29503
|
+
</details>
|
|
29504
|
+
|
|
29505
|
+
<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>
|
|
29506
|
+
<dl>
|
|
29507
|
+
<dd>
|
|
29508
|
+
|
|
29509
|
+
#### 📝 Description
|
|
29510
|
+
|
|
29511
|
+
<dl>
|
|
29512
|
+
<dd>
|
|
29513
|
+
|
|
29514
|
+
<dl>
|
|
29515
|
+
<dd>
|
|
29516
|
+
|
|
29517
|
+
Returns the billing profile currently assigned to an entity, including
|
|
29518
|
+
its billable events and fee schedules. Use it to read the pricing terms
|
|
29519
|
+
in effect for an organization, paypoint, template, or application.
|
|
29520
|
+
|
|
29521
|
+
Requires a token with the `billing_profile_read` permission and access
|
|
29522
|
+
to the requested entity; otherwise the call gets `403 Forbidden`.
|
|
29523
|
+
|
|
29524
|
+
If the entity exists but has no profile assigned, the call returns
|
|
29525
|
+
`404 Not Found`.
|
|
29526
|
+
</dd>
|
|
29527
|
+
</dl>
|
|
29528
|
+
</dd>
|
|
29529
|
+
</dl>
|
|
29530
|
+
|
|
29531
|
+
#### 🔌 Usage
|
|
29532
|
+
|
|
29533
|
+
<dl>
|
|
29534
|
+
<dd>
|
|
29535
|
+
|
|
29536
|
+
<dl>
|
|
29537
|
+
<dd>
|
|
29538
|
+
|
|
29539
|
+
```ruby
|
|
29540
|
+
client.billing.get_profile(
|
|
29541
|
+
service_group: "PayIn",
|
|
29542
|
+
entity_type: "Organization",
|
|
29543
|
+
entity_id: 123
|
|
29544
|
+
)
|
|
29545
|
+
```
|
|
29546
|
+
</dd>
|
|
29547
|
+
</dl>
|
|
29548
|
+
</dd>
|
|
29549
|
+
</dl>
|
|
29550
|
+
|
|
29551
|
+
#### ⚙️ Parameters
|
|
29552
|
+
|
|
29553
|
+
<dl>
|
|
29554
|
+
<dd>
|
|
29555
|
+
|
|
29556
|
+
<dl>
|
|
29557
|
+
<dd>
|
|
29558
|
+
|
|
29559
|
+
**service_group:** `Payabli::Billing::Types::GetProfileBillingRequestServiceGroup`
|
|
29560
|
+
|
|
29561
|
+
The billing vertical. Only `PayIn` and `PayOut` are accepted; any
|
|
29562
|
+
other value returns `400 Bad Request`.
|
|
29563
|
+
|
|
29564
|
+
</dd>
|
|
29565
|
+
</dl>
|
|
29566
|
+
|
|
29567
|
+
<dl>
|
|
29568
|
+
<dd>
|
|
29569
|
+
|
|
29570
|
+
**entity_type:** `Payabli::Billing::Types::GetProfileBillingRequestEntityType`
|
|
29571
|
+
|
|
29572
|
+
The owning entity type: `Organization`, `Paypoint`, `Template`, or
|
|
29573
|
+
`Application`.
|
|
29574
|
+
|
|
29575
|
+
</dd>
|
|
29576
|
+
</dl>
|
|
29577
|
+
|
|
29578
|
+
<dl>
|
|
29579
|
+
<dd>
|
|
29580
|
+
|
|
29581
|
+
**entity_id:** `Integer` — The numeric identifier of the entity.
|
|
29582
|
+
|
|
29583
|
+
</dd>
|
|
29584
|
+
</dl>
|
|
29585
|
+
|
|
29586
|
+
<dl>
|
|
29587
|
+
<dd>
|
|
29588
|
+
|
|
29589
|
+
**request_options:** `Payabli::Billing::RequestOptions`
|
|
29590
|
+
|
|
29591
|
+
</dd>
|
|
29592
|
+
</dl>
|
|
29593
|
+
</dd>
|
|
29594
|
+
</dl>
|
|
29595
|
+
|
|
29596
|
+
|
|
29597
|
+
</dd>
|
|
29598
|
+
</dl>
|
|
29599
|
+
</details>
|
|
29600
|
+
|