payabli 2.2.20 → 2.2.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.fern/metadata.json +4 -3
- data/LICENSE.md +5 -6
- data/README.md +6 -0
- data/lib/payabli/bill/client.rb +11 -11
- data/lib/payabli/boarding/client.rb +10 -10
- data/lib/payabli/charge_backs/client.rb +3 -3
- data/lib/payabli/client.rb +11 -1
- data/lib/payabli/cloud/client.rb +4 -4
- data/lib/payabli/customer/client.rb +6 -6
- data/lib/payabli/export/client.rb +29 -29
- data/lib/payabli/ghost_card/client.rb +99 -0
- data/lib/payabli/ghost_card/types/card_status.rb +16 -0
- data/lib/payabli/ghost_card/types/create_ghost_card_request_body.rb +27 -0
- data/lib/payabli/ghost_card/types/create_ghost_card_response.rb +14 -0
- data/lib/payabli/ghost_card/types/create_ghost_card_response_data.rb +13 -0
- data/lib/payabli/ghost_card/types/update_card_request_body.rb +13 -0
- data/lib/payabli/hosted_payment_pages/client.rb +3 -3
- data/lib/payabli/import/client.rb +3 -3
- data/lib/payabli/invoice/client.rb +11 -11
- data/lib/payabli/line_item/client.rb +5 -5
- data/lib/payabli/money_in/client.rb +13 -13
- data/lib/payabli/money_out/client.rb +7 -7
- data/lib/payabli/notification/client.rb +4 -4
- data/lib/payabli/notificationlogs/client.rb +2 -2
- data/lib/payabli/ocr/client.rb +2 -2
- data/lib/payabli/organization/client.rb +6 -6
- data/lib/payabli/payment_link/client.rb +11 -11
- data/lib/payabli/payment_method_domain/client.rb +5 -5
- data/lib/payabli/payout_subscription/client.rb +160 -0
- data/lib/payabli/payout_subscription/types/add_payout_subscription_response.rb +15 -0
- data/lib/payabli/payout_subscription/types/delete_payout_subscription_response.rb +14 -0
- data/lib/payabli/payout_subscription/types/get_payout_subscription_response.rb +14 -0
- data/lib/payabli/payout_subscription/types/payout_payment_detail.rb +24 -0
- data/lib/payabli/payout_subscription/types/payout_schedule_detail.rb +13 -0
- data/lib/payabli/payout_subscription/types/payout_set_pause.rb +25 -0
- data/lib/payabli/payout_subscription/types/payout_subscription_query_record.rb +39 -0
- data/lib/payabli/payout_subscription/types/payout_subscription_query_record_pascal.rb +39 -0
- data/lib/payabli/payout_subscription/types/payout_subscription_request_body.rb +20 -0
- data/lib/payabli/payout_subscription/types/query_payout_subscription_response.rb +13 -0
- data/lib/payabli/payout_subscription/types/request_payout_schedule.rb +12 -0
- data/lib/payabli/payout_subscription/types/update_payout_subscription_body.rb +14 -0
- data/lib/payabli/payout_subscription/types/update_payout_subscription_response.rb +15 -0
- data/lib/payabli/paypoint/client.rb +7 -7
- data/lib/payabli/query/client.rb +143 -43
- data/lib/payabli/query/types/list_payout_subscriptions_org_request.rb +16 -0
- data/lib/payabli/query/types/list_payout_subscriptions_request.rb +16 -0
- data/lib/payabli/statistic/client.rb +4 -4
- data/lib/payabli/subscription/client.rb +3 -3
- data/lib/payabli/templates/client.rb +4 -4
- data/lib/payabli/token_storage/client.rb +3 -3
- data/lib/payabli/user/client.rb +6 -6
- data/lib/payabli/vendor/client.rb +4 -4
- data/lib/payabli/version.rb +1 -1
- data/lib/payabli.rb +22 -0
- data/reference.md +1304 -372
- data/wiremock/wiremock-mappings.json +1 -1
- metadata +23 -1
data/reference.md
CHANGED
|
@@ -8027,6 +8027,300 @@ Example: `netAmount(gt)=20` returns all records with a `netAmount` greater than
|
|
|
8027
8027
|
</dl>
|
|
8028
8028
|
|
|
8029
8029
|
|
|
8030
|
+
</dd>
|
|
8031
|
+
</dl>
|
|
8032
|
+
</details>
|
|
8033
|
+
|
|
8034
|
+
## GhostCard
|
|
8035
|
+
<details><summary><code>client.ghost_card.<a href="/lib/payabli/ghost_card/client.rb">create_ghost_card</a>(entry, request) -> Payabli::GhostCard::Types::CreateGhostCardResponse</code></summary>
|
|
8036
|
+
<dl>
|
|
8037
|
+
<dd>
|
|
8038
|
+
|
|
8039
|
+
#### 📝 Description
|
|
8040
|
+
|
|
8041
|
+
<dl>
|
|
8042
|
+
<dd>
|
|
8043
|
+
|
|
8044
|
+
<dl>
|
|
8045
|
+
<dd>
|
|
8046
|
+
|
|
8047
|
+
Creates a ghost card, a multi-use virtual debit card issued to a vendor for recurring or discretionary spend.
|
|
8048
|
+
|
|
8049
|
+
Unlike single-use virtual cards issued as part of a payout transaction, ghost cards aren't tied to a specific payout. They're issued directly to a vendor and can be reused up to a configurable number of times within the card's spending limits.
|
|
8050
|
+
|
|
8051
|
+
Only one ghost card can exist per vendor per paypoint. To issue a new card to the same vendor, cancel the existing card first.
|
|
8052
|
+
</dd>
|
|
8053
|
+
</dl>
|
|
8054
|
+
</dd>
|
|
8055
|
+
</dl>
|
|
8056
|
+
|
|
8057
|
+
#### 🔌 Usage
|
|
8058
|
+
|
|
8059
|
+
<dl>
|
|
8060
|
+
<dd>
|
|
8061
|
+
|
|
8062
|
+
<dl>
|
|
8063
|
+
<dd>
|
|
8064
|
+
|
|
8065
|
+
```ruby
|
|
8066
|
+
client.ghost_card.create_ghost_card(
|
|
8067
|
+
entry: "8cfec2e0fa",
|
|
8068
|
+
vendor_id: 42,
|
|
8069
|
+
expense_limit: 500,
|
|
8070
|
+
amount: 500,
|
|
8071
|
+
max_number_of_uses: 3,
|
|
8072
|
+
exact_amount: false,
|
|
8073
|
+
expense_limit_period: "monthly",
|
|
8074
|
+
billing_cycle: "monthly",
|
|
8075
|
+
billing_cycle_day: "1",
|
|
8076
|
+
daily_transaction_count: 5,
|
|
8077
|
+
daily_amount_limit: 200,
|
|
8078
|
+
transaction_amount_limit: 100,
|
|
8079
|
+
mcc: "5411",
|
|
8080
|
+
tcc: "R",
|
|
8081
|
+
misc_1: "PO-98765",
|
|
8082
|
+
misc_2: "Dept-Finance"
|
|
8083
|
+
)
|
|
8084
|
+
```
|
|
8085
|
+
</dd>
|
|
8086
|
+
</dl>
|
|
8087
|
+
</dd>
|
|
8088
|
+
</dl>
|
|
8089
|
+
|
|
8090
|
+
#### ⚙️ Parameters
|
|
8091
|
+
|
|
8092
|
+
<dl>
|
|
8093
|
+
<dd>
|
|
8094
|
+
|
|
8095
|
+
<dl>
|
|
8096
|
+
<dd>
|
|
8097
|
+
|
|
8098
|
+
**entry:** `String`
|
|
8099
|
+
|
|
8100
|
+
</dd>
|
|
8101
|
+
</dl>
|
|
8102
|
+
|
|
8103
|
+
<dl>
|
|
8104
|
+
<dd>
|
|
8105
|
+
|
|
8106
|
+
**vendor_id:** `Integer` — ID of the vendor who receives the card. The vendor must belong to the paypoint and have an active status.
|
|
8107
|
+
|
|
8108
|
+
</dd>
|
|
8109
|
+
</dl>
|
|
8110
|
+
|
|
8111
|
+
<dl>
|
|
8112
|
+
<dd>
|
|
8113
|
+
|
|
8114
|
+
**expense_limit:** `Integer` — Spending limit for the card. Must be greater than `0` and can't exceed the paypoint's configured payout credit limit.
|
|
8115
|
+
|
|
8116
|
+
</dd>
|
|
8117
|
+
</dl>
|
|
8118
|
+
|
|
8119
|
+
<dl>
|
|
8120
|
+
<dd>
|
|
8121
|
+
|
|
8122
|
+
**expiration_date:** `String` — Requested expiration date for the card. If not provided, defaults to 30 days from creation.
|
|
8123
|
+
|
|
8124
|
+
</dd>
|
|
8125
|
+
</dl>
|
|
8126
|
+
|
|
8127
|
+
<dl>
|
|
8128
|
+
<dd>
|
|
8129
|
+
|
|
8130
|
+
**amount:** `Integer` — Initial load amount for the card.
|
|
8131
|
+
|
|
8132
|
+
</dd>
|
|
8133
|
+
</dl>
|
|
8134
|
+
|
|
8135
|
+
<dl>
|
|
8136
|
+
<dd>
|
|
8137
|
+
|
|
8138
|
+
**max_number_of_uses:** `Integer` — Maximum number of times the card can be used. Ignored and set to `1` when `exactAmount` is `true`.
|
|
8139
|
+
|
|
8140
|
+
</dd>
|
|
8141
|
+
</dl>
|
|
8142
|
+
|
|
8143
|
+
<dl>
|
|
8144
|
+
<dd>
|
|
8145
|
+
|
|
8146
|
+
**exact_amount:** `Internal::Types::Boolean` — When `true`, restricts the card to a single use. `maxNumberOfUses` is automatically set to `1` regardless of any other value provided.
|
|
8147
|
+
|
|
8148
|
+
</dd>
|
|
8149
|
+
</dl>
|
|
8150
|
+
|
|
8151
|
+
<dl>
|
|
8152
|
+
<dd>
|
|
8153
|
+
|
|
8154
|
+
**expense_limit_period:** `String` — Time period over which `expenseLimit` applies (for example, `monthly` or `weekly`).
|
|
8155
|
+
|
|
8156
|
+
</dd>
|
|
8157
|
+
</dl>
|
|
8158
|
+
|
|
8159
|
+
<dl>
|
|
8160
|
+
<dd>
|
|
8161
|
+
|
|
8162
|
+
**billing_cycle:** `String` — Billing cycle identifier.
|
|
8163
|
+
|
|
8164
|
+
</dd>
|
|
8165
|
+
</dl>
|
|
8166
|
+
|
|
8167
|
+
<dl>
|
|
8168
|
+
<dd>
|
|
8169
|
+
|
|
8170
|
+
**billing_cycle_day:** `String` — Day within the billing cycle.
|
|
8171
|
+
|
|
8172
|
+
</dd>
|
|
8173
|
+
</dl>
|
|
8174
|
+
|
|
8175
|
+
<dl>
|
|
8176
|
+
<dd>
|
|
8177
|
+
|
|
8178
|
+
**daily_transaction_count:** `Integer` — Maximum number of transactions allowed per day.
|
|
8179
|
+
|
|
8180
|
+
</dd>
|
|
8181
|
+
</dl>
|
|
8182
|
+
|
|
8183
|
+
<dl>
|
|
8184
|
+
<dd>
|
|
8185
|
+
|
|
8186
|
+
**daily_amount_limit:** `Integer` — Maximum total spend allowed per day.
|
|
8187
|
+
|
|
8188
|
+
</dd>
|
|
8189
|
+
</dl>
|
|
8190
|
+
|
|
8191
|
+
<dl>
|
|
8192
|
+
<dd>
|
|
8193
|
+
|
|
8194
|
+
**transaction_amount_limit:** `Integer` — Maximum spend allowed per single transaction.
|
|
8195
|
+
|
|
8196
|
+
</dd>
|
|
8197
|
+
</dl>
|
|
8198
|
+
|
|
8199
|
+
<dl>
|
|
8200
|
+
<dd>
|
|
8201
|
+
|
|
8202
|
+
**mcc:** `String` — Merchant Category Code to restrict where the card can be used. Must be a valid MCC if provided.
|
|
8203
|
+
|
|
8204
|
+
</dd>
|
|
8205
|
+
</dl>
|
|
8206
|
+
|
|
8207
|
+
<dl>
|
|
8208
|
+
<dd>
|
|
8209
|
+
|
|
8210
|
+
**tcc:** `String` — Transaction Category Code to restrict where the card can be used. Must be a valid TCC if provided.
|
|
8211
|
+
|
|
8212
|
+
</dd>
|
|
8213
|
+
</dl>
|
|
8214
|
+
|
|
8215
|
+
<dl>
|
|
8216
|
+
<dd>
|
|
8217
|
+
|
|
8218
|
+
**misc_1:** `String` — Custom metadata field. Stored on the card record.
|
|
8219
|
+
|
|
8220
|
+
</dd>
|
|
8221
|
+
</dl>
|
|
8222
|
+
|
|
8223
|
+
<dl>
|
|
8224
|
+
<dd>
|
|
8225
|
+
|
|
8226
|
+
**misc_2:** `String` — Custom metadata field. Stored on the card record.
|
|
8227
|
+
|
|
8228
|
+
</dd>
|
|
8229
|
+
</dl>
|
|
8230
|
+
|
|
8231
|
+
<dl>
|
|
8232
|
+
<dd>
|
|
8233
|
+
|
|
8234
|
+
**request_options:** `Payabli::GhostCard::RequestOptions`
|
|
8235
|
+
|
|
8236
|
+
</dd>
|
|
8237
|
+
</dl>
|
|
8238
|
+
</dd>
|
|
8239
|
+
</dl>
|
|
8240
|
+
|
|
8241
|
+
|
|
8242
|
+
</dd>
|
|
8243
|
+
</dl>
|
|
8244
|
+
</details>
|
|
8245
|
+
|
|
8246
|
+
<details><summary><code>client.ghost_card.<a href="/lib/payabli/ghost_card/client.rb">update_card</a>(entry, request) -> Payabli::Types::PayabliApiResponse</code></summary>
|
|
8247
|
+
<dl>
|
|
8248
|
+
<dd>
|
|
8249
|
+
|
|
8250
|
+
#### 📝 Description
|
|
8251
|
+
|
|
8252
|
+
<dl>
|
|
8253
|
+
<dd>
|
|
8254
|
+
|
|
8255
|
+
<dl>
|
|
8256
|
+
<dd>
|
|
8257
|
+
|
|
8258
|
+
Updates the status of a virtual card (including ghost cards) under a paypoint.
|
|
8259
|
+
</dd>
|
|
8260
|
+
</dl>
|
|
8261
|
+
</dd>
|
|
8262
|
+
</dl>
|
|
8263
|
+
|
|
8264
|
+
#### 🔌 Usage
|
|
8265
|
+
|
|
8266
|
+
<dl>
|
|
8267
|
+
<dd>
|
|
8268
|
+
|
|
8269
|
+
<dl>
|
|
8270
|
+
<dd>
|
|
8271
|
+
|
|
8272
|
+
```ruby
|
|
8273
|
+
client.ghost_card.update_card(
|
|
8274
|
+
entry: "8cfec2e0fa",
|
|
8275
|
+
card_token: "gc_abc123def456",
|
|
8276
|
+
status: "Cancelled"
|
|
8277
|
+
)
|
|
8278
|
+
```
|
|
8279
|
+
</dd>
|
|
8280
|
+
</dl>
|
|
8281
|
+
</dd>
|
|
8282
|
+
</dl>
|
|
8283
|
+
|
|
8284
|
+
#### ⚙️ Parameters
|
|
8285
|
+
|
|
8286
|
+
<dl>
|
|
8287
|
+
<dd>
|
|
8288
|
+
|
|
8289
|
+
<dl>
|
|
8290
|
+
<dd>
|
|
8291
|
+
|
|
8292
|
+
**entry:** `String`
|
|
8293
|
+
|
|
8294
|
+
</dd>
|
|
8295
|
+
</dl>
|
|
8296
|
+
|
|
8297
|
+
<dl>
|
|
8298
|
+
<dd>
|
|
8299
|
+
|
|
8300
|
+
**card_token:** `String` — Token that uniquely identifies the card. This is the `ReferenceId` returned when the card was created.
|
|
8301
|
+
|
|
8302
|
+
</dd>
|
|
8303
|
+
</dl>
|
|
8304
|
+
|
|
8305
|
+
<dl>
|
|
8306
|
+
<dd>
|
|
8307
|
+
|
|
8308
|
+
**status:** `Payabli::GhostCard::Types::CardStatus` — The new status to set on the card.
|
|
8309
|
+
|
|
8310
|
+
</dd>
|
|
8311
|
+
</dl>
|
|
8312
|
+
|
|
8313
|
+
<dl>
|
|
8314
|
+
<dd>
|
|
8315
|
+
|
|
8316
|
+
**request_options:** `Payabli::GhostCard::RequestOptions`
|
|
8317
|
+
|
|
8318
|
+
</dd>
|
|
8319
|
+
</dl>
|
|
8320
|
+
</dd>
|
|
8321
|
+
</dl>
|
|
8322
|
+
|
|
8323
|
+
|
|
8030
8324
|
</dd>
|
|
8031
8325
|
</dl>
|
|
8032
8326
|
</details>
|
|
@@ -15881,8 +16175,8 @@ client.payment_method_domain.verify_payment_method_domain(domain_id: "pmd_b8237f
|
|
|
15881
16175
|
</dl>
|
|
15882
16176
|
</details>
|
|
15883
16177
|
|
|
15884
|
-
##
|
|
15885
|
-
<details><summary><code>client.
|
|
16178
|
+
## PayoutSubscription
|
|
16179
|
+
<details><summary><code>client.payout_subscription.<a href="/lib/payabli/payout_subscription/client.rb">create_payout_subscription</a>(request) -> Payabli::PayoutSubscription::Types::AddPayoutSubscriptionResponse</code></summary>
|
|
15886
16180
|
<dl>
|
|
15887
16181
|
<dd>
|
|
15888
16182
|
|
|
@@ -15894,7 +16188,7 @@ client.payment_method_domain.verify_payment_method_domain(domain_id: "pmd_b8237f
|
|
|
15894
16188
|
<dl>
|
|
15895
16189
|
<dd>
|
|
15896
16190
|
|
|
15897
|
-
|
|
16191
|
+
Creates a payout subscription to automatically send payouts to a vendor on a recurring schedule. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for a step-by-step guide.
|
|
15898
16192
|
</dd>
|
|
15899
16193
|
</dl>
|
|
15900
16194
|
</dd>
|
|
@@ -15909,13 +16203,41 @@ Gets the basic details for a paypoint.
|
|
|
15909
16203
|
<dd>
|
|
15910
16204
|
|
|
15911
16205
|
```ruby
|
|
15912
|
-
client.
|
|
15913
|
-
|
|
15914
|
-
|
|
15915
|
-
|
|
15916
|
-
|
|
15917
|
-
|
|
15918
|
-
|
|
16206
|
+
client.payout_subscription.create_payout_subscription(
|
|
16207
|
+
entry_point: "d193cf9a46",
|
|
16208
|
+
payment_method: {
|
|
16209
|
+
method_: "ach",
|
|
16210
|
+
ach_holder: "Herman Coatings",
|
|
16211
|
+
ach_routing: "021000021",
|
|
16212
|
+
ach_account: "3453445666",
|
|
16213
|
+
ach_account_type: "checking"
|
|
16214
|
+
},
|
|
16215
|
+
payment_details: {
|
|
16216
|
+
total_amount: 500,
|
|
16217
|
+
service_fee: 0,
|
|
16218
|
+
currency: "USD"
|
|
16219
|
+
},
|
|
16220
|
+
vendor_data: {
|
|
16221
|
+
vendor_id: 1501
|
|
16222
|
+
},
|
|
16223
|
+
bill_data: [{
|
|
16224
|
+
invoice_number: "INV-5001",
|
|
16225
|
+
net_amount: "500",
|
|
16226
|
+
invoice_date: "2025-08-01",
|
|
16227
|
+
due_date: "2025-08-15"
|
|
16228
|
+
}],
|
|
16229
|
+
schedule_details: {
|
|
16230
|
+
start_date: "09/01/2025",
|
|
16231
|
+
end_date: "09/01/2026",
|
|
16232
|
+
frequency: "monthly"
|
|
16233
|
+
}
|
|
16234
|
+
)
|
|
16235
|
+
```
|
|
16236
|
+
</dd>
|
|
16237
|
+
</dl>
|
|
16238
|
+
</dd>
|
|
16239
|
+
</dl>
|
|
16240
|
+
|
|
15919
16241
|
#### ⚙️ Parameters
|
|
15920
16242
|
|
|
15921
16243
|
<dl>
|
|
@@ -15924,7 +16246,7 @@ client.paypoint.get_basic_entry(entry: "8cfec329267")
|
|
|
15924
16246
|
<dl>
|
|
15925
16247
|
<dd>
|
|
15926
16248
|
|
|
15927
|
-
**
|
|
16249
|
+
**idempotency_key:** `String`
|
|
15928
16250
|
|
|
15929
16251
|
</dd>
|
|
15930
16252
|
</dl>
|
|
@@ -15932,7 +16254,15 @@ client.paypoint.get_basic_entry(entry: "8cfec329267")
|
|
|
15932
16254
|
<dl>
|
|
15933
16255
|
<dd>
|
|
15934
16256
|
|
|
15935
|
-
**
|
|
16257
|
+
**request:** `Payabli::PayoutSubscription::Types::PayoutSubscriptionRequestBody`
|
|
16258
|
+
|
|
16259
|
+
</dd>
|
|
16260
|
+
</dl>
|
|
16261
|
+
|
|
16262
|
+
<dl>
|
|
16263
|
+
<dd>
|
|
16264
|
+
|
|
16265
|
+
**request_options:** `Payabli::PayoutSubscription::RequestOptions`
|
|
15936
16266
|
|
|
15937
16267
|
</dd>
|
|
15938
16268
|
</dl>
|
|
@@ -15944,7 +16274,7 @@ client.paypoint.get_basic_entry(entry: "8cfec329267")
|
|
|
15944
16274
|
</dl>
|
|
15945
16275
|
</details>
|
|
15946
16276
|
|
|
15947
|
-
<details><summary><code>client.
|
|
16277
|
+
<details><summary><code>client.payout_subscription.<a href="/lib/payabli/payout_subscription/client.rb">get_payout_subscription</a>(id) -> Payabli::PayoutSubscription::Types::GetPayoutSubscriptionResponse</code></summary>
|
|
15948
16278
|
<dl>
|
|
15949
16279
|
<dd>
|
|
15950
16280
|
|
|
@@ -15956,7 +16286,7 @@ client.paypoint.get_basic_entry(entry: "8cfec329267")
|
|
|
15956
16286
|
<dl>
|
|
15957
16287
|
<dd>
|
|
15958
16288
|
|
|
15959
|
-
Retrieves
|
|
16289
|
+
Retrieves a single payout subscription's details. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
|
|
15960
16290
|
</dd>
|
|
15961
16291
|
</dl>
|
|
15962
16292
|
</dd>
|
|
@@ -15971,7 +16301,7 @@ Retrieves the basic details for a paypoint by ID.
|
|
|
15971
16301
|
<dd>
|
|
15972
16302
|
|
|
15973
16303
|
```ruby
|
|
15974
|
-
client.
|
|
16304
|
+
client.payout_subscription.get_payout_subscription(id: 42)
|
|
15975
16305
|
```
|
|
15976
16306
|
</dd>
|
|
15977
16307
|
</dl>
|
|
@@ -15986,7 +16316,7 @@ client.paypoint.get_basic_entry_by_id(id_paypoint: "198")
|
|
|
15986
16316
|
<dl>
|
|
15987
16317
|
<dd>
|
|
15988
16318
|
|
|
15989
|
-
**
|
|
16319
|
+
**id:** `Integer` — The payout subscription ID.
|
|
15990
16320
|
|
|
15991
16321
|
</dd>
|
|
15992
16322
|
</dl>
|
|
@@ -15994,7 +16324,7 @@ client.paypoint.get_basic_entry_by_id(id_paypoint: "198")
|
|
|
15994
16324
|
<dl>
|
|
15995
16325
|
<dd>
|
|
15996
16326
|
|
|
15997
|
-
**request_options:** `Payabli::
|
|
16327
|
+
**request_options:** `Payabli::PayoutSubscription::RequestOptions`
|
|
15998
16328
|
|
|
15999
16329
|
</dd>
|
|
16000
16330
|
</dl>
|
|
@@ -16006,7 +16336,7 @@ client.paypoint.get_basic_entry_by_id(id_paypoint: "198")
|
|
|
16006
16336
|
</dl>
|
|
16007
16337
|
</details>
|
|
16008
16338
|
|
|
16009
|
-
<details><summary><code>client.
|
|
16339
|
+
<details><summary><code>client.payout_subscription.<a href="/lib/payabli/payout_subscription/client.rb">update_payout_subscription</a>(id, request) -> Payabli::PayoutSubscription::Types::UpdatePayoutSubscriptionResponse</code></summary>
|
|
16010
16340
|
<dl>
|
|
16011
16341
|
<dd>
|
|
16012
16342
|
|
|
@@ -16018,7 +16348,7 @@ client.paypoint.get_basic_entry_by_id(id_paypoint: "198")
|
|
|
16018
16348
|
<dl>
|
|
16019
16349
|
<dd>
|
|
16020
16350
|
|
|
16021
|
-
|
|
16351
|
+
Updates a payout subscription's details. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
|
|
16022
16352
|
</dd>
|
|
16023
16353
|
</dl>
|
|
16024
16354
|
</dd>
|
|
@@ -16033,7 +16363,10 @@ Gets the details for a single paypoint.
|
|
|
16033
16363
|
<dd>
|
|
16034
16364
|
|
|
16035
16365
|
```ruby
|
|
16036
|
-
client.
|
|
16366
|
+
client.payout_subscription.update_payout_subscription(
|
|
16367
|
+
id: 42,
|
|
16368
|
+
set_pause: true
|
|
16369
|
+
)
|
|
16037
16370
|
```
|
|
16038
16371
|
</dd>
|
|
16039
16372
|
</dl>
|
|
@@ -16048,7 +16381,7 @@ client.paypoint.get_entry_config(entry: "8cfec329267")
|
|
|
16048
16381
|
<dl>
|
|
16049
16382
|
<dd>
|
|
16050
16383
|
|
|
16051
|
-
**
|
|
16384
|
+
**id:** `Integer` — The payout subscription ID.
|
|
16052
16385
|
|
|
16053
16386
|
</dd>
|
|
16054
16387
|
</dl>
|
|
@@ -16056,7 +16389,7 @@ client.paypoint.get_entry_config(entry: "8cfec329267")
|
|
|
16056
16389
|
<dl>
|
|
16057
16390
|
<dd>
|
|
16058
16391
|
|
|
16059
|
-
**
|
|
16392
|
+
**request:** `Payabli::PayoutSubscription::Types::UpdatePayoutSubscriptionBody`
|
|
16060
16393
|
|
|
16061
16394
|
</dd>
|
|
16062
16395
|
</dl>
|
|
@@ -16064,7 +16397,7 @@ client.paypoint.get_entry_config(entry: "8cfec329267")
|
|
|
16064
16397
|
<dl>
|
|
16065
16398
|
<dd>
|
|
16066
16399
|
|
|
16067
|
-
**request_options:** `Payabli::
|
|
16400
|
+
**request_options:** `Payabli::PayoutSubscription::RequestOptions`
|
|
16068
16401
|
|
|
16069
16402
|
</dd>
|
|
16070
16403
|
</dl>
|
|
@@ -16076,7 +16409,7 @@ client.paypoint.get_entry_config(entry: "8cfec329267")
|
|
|
16076
16409
|
</dl>
|
|
16077
16410
|
</details>
|
|
16078
16411
|
|
|
16079
|
-
<details><summary><code>client.
|
|
16412
|
+
<details><summary><code>client.payout_subscription.<a href="/lib/payabli/payout_subscription/client.rb">delete_payout_subscription</a>(id) -> Payabli::PayoutSubscription::Types::DeletePayoutSubscriptionResponse</code></summary>
|
|
16080
16413
|
<dl>
|
|
16081
16414
|
<dd>
|
|
16082
16415
|
|
|
@@ -16088,7 +16421,7 @@ client.paypoint.get_entry_config(entry: "8cfec329267")
|
|
|
16088
16421
|
<dl>
|
|
16089
16422
|
<dd>
|
|
16090
16423
|
|
|
16091
|
-
|
|
16424
|
+
Deletes a payout subscription and prevents future payouts. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
|
|
16092
16425
|
</dd>
|
|
16093
16426
|
</dl>
|
|
16094
16427
|
</dd>
|
|
@@ -16103,10 +16436,7 @@ Gets the details for single payment page for a paypoint.
|
|
|
16103
16436
|
<dd>
|
|
16104
16437
|
|
|
16105
16438
|
```ruby
|
|
16106
|
-
client.
|
|
16107
|
-
entry: "8cfec329267",
|
|
16108
|
-
subdomain: "pay-your-fees-1"
|
|
16109
|
-
)
|
|
16439
|
+
client.payout_subscription.delete_payout_subscription(id: 42)
|
|
16110
16440
|
```
|
|
16111
16441
|
</dd>
|
|
16112
16442
|
</dl>
|
|
@@ -16121,15 +16451,7 @@ client.paypoint.get_page(
|
|
|
16121
16451
|
<dl>
|
|
16122
16452
|
<dd>
|
|
16123
16453
|
|
|
16124
|
-
**
|
|
16125
|
-
|
|
16126
|
-
</dd>
|
|
16127
|
-
</dl>
|
|
16128
|
-
|
|
16129
|
-
<dl>
|
|
16130
|
-
<dd>
|
|
16131
|
-
|
|
16132
|
-
**subdomain:** `String` — Payment page identifier. The subdomain value is the last portion of the payment page URL. For example, in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
|
|
16454
|
+
**id:** `Integer` — The payout subscription ID.
|
|
16133
16455
|
|
|
16134
16456
|
</dd>
|
|
16135
16457
|
</dl>
|
|
@@ -16137,7 +16459,7 @@ client.paypoint.get_page(
|
|
|
16137
16459
|
<dl>
|
|
16138
16460
|
<dd>
|
|
16139
16461
|
|
|
16140
|
-
**request_options:** `Payabli::
|
|
16462
|
+
**request_options:** `Payabli::PayoutSubscription::RequestOptions`
|
|
16141
16463
|
|
|
16142
16464
|
</dd>
|
|
16143
16465
|
</dl>
|
|
@@ -16149,7 +16471,8 @@ client.paypoint.get_page(
|
|
|
16149
16471
|
</dl>
|
|
16150
16472
|
</details>
|
|
16151
16473
|
|
|
16152
|
-
|
|
16474
|
+
## Paypoint
|
|
16475
|
+
<details><summary><code>client.paypoint.<a href="/lib/payabli/paypoint/client.rb">get_basic_entry</a>(entry) -> Payabli::Paypoint::Types::GetBasicEntryResponse</code></summary>
|
|
16153
16476
|
<dl>
|
|
16154
16477
|
<dd>
|
|
16155
16478
|
|
|
@@ -16161,7 +16484,7 @@ client.paypoint.get_page(
|
|
|
16161
16484
|
<dl>
|
|
16162
16485
|
<dd>
|
|
16163
16486
|
|
|
16164
|
-
|
|
16487
|
+
Gets the basic details for a paypoint.
|
|
16165
16488
|
</dd>
|
|
16166
16489
|
</dl>
|
|
16167
16490
|
</dd>
|
|
@@ -16176,10 +16499,7 @@ Deletes a payment page in a paypoint.
|
|
|
16176
16499
|
<dd>
|
|
16177
16500
|
|
|
16178
16501
|
```ruby
|
|
16179
|
-
client.paypoint.
|
|
16180
|
-
entry: "8cfec329267",
|
|
16181
|
-
subdomain: "pay-your-fees-1"
|
|
16182
|
-
)
|
|
16502
|
+
client.paypoint.get_basic_entry(entry: "8cfec329267")
|
|
16183
16503
|
```
|
|
16184
16504
|
</dd>
|
|
16185
16505
|
</dl>
|
|
@@ -16202,14 +16522,6 @@ client.paypoint.remove_page(
|
|
|
16202
16522
|
<dl>
|
|
16203
16523
|
<dd>
|
|
16204
16524
|
|
|
16205
|
-
**subdomain:** `String` — Payment page identifier. The subdomain value is the last portion of the payment page URL. For example, in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
|
|
16206
|
-
|
|
16207
|
-
</dd>
|
|
16208
|
-
</dl>
|
|
16209
|
-
|
|
16210
|
-
<dl>
|
|
16211
|
-
<dd>
|
|
16212
|
-
|
|
16213
16525
|
**request_options:** `Payabli::Paypoint::RequestOptions`
|
|
16214
16526
|
|
|
16215
16527
|
</dd>
|
|
@@ -16222,7 +16534,7 @@ client.paypoint.remove_page(
|
|
|
16222
16534
|
</dl>
|
|
16223
16535
|
</details>
|
|
16224
16536
|
|
|
16225
|
-
<details><summary><code>client.paypoint.<a href="/lib/payabli/paypoint/client.rb">
|
|
16537
|
+
<details><summary><code>client.paypoint.<a href="/lib/payabli/paypoint/client.rb">get_basic_entry_by_id</a>(id_paypoint) -> Payabli::Paypoint::Types::GetBasicEntryByIdResponse</code></summary>
|
|
16226
16538
|
<dl>
|
|
16227
16539
|
<dd>
|
|
16228
16540
|
|
|
@@ -16234,7 +16546,7 @@ client.paypoint.remove_page(
|
|
|
16234
16546
|
<dl>
|
|
16235
16547
|
<dd>
|
|
16236
16548
|
|
|
16237
|
-
|
|
16549
|
+
Retrieves the basic details for a paypoint by ID.
|
|
16238
16550
|
</dd>
|
|
16239
16551
|
</dl>
|
|
16240
16552
|
</dd>
|
|
@@ -16249,7 +16561,7 @@ Updates a paypoint logo.
|
|
|
16249
16561
|
<dd>
|
|
16250
16562
|
|
|
16251
16563
|
```ruby
|
|
16252
|
-
client.paypoint.
|
|
16564
|
+
client.paypoint.get_basic_entry_by_id(id_paypoint: "198")
|
|
16253
16565
|
```
|
|
16254
16566
|
</dd>
|
|
16255
16567
|
</dl>
|
|
@@ -16264,15 +16576,7 @@ client.paypoint.save_logo(entry: "8cfec329267")
|
|
|
16264
16576
|
<dl>
|
|
16265
16577
|
<dd>
|
|
16266
16578
|
|
|
16267
|
-
**
|
|
16268
|
-
|
|
16269
|
-
</dd>
|
|
16270
|
-
</dl>
|
|
16271
|
-
|
|
16272
|
-
<dl>
|
|
16273
|
-
<dd>
|
|
16274
|
-
|
|
16275
|
-
**request:** `Payabli::Types::FileContent`
|
|
16579
|
+
**id_paypoint:** `String` — Paypoint ID. You can find this value by querying `/api/Query/paypoints/{orgId}`
|
|
16276
16580
|
|
|
16277
16581
|
</dd>
|
|
16278
16582
|
</dl>
|
|
@@ -16292,7 +16596,7 @@ client.paypoint.save_logo(entry: "8cfec329267")
|
|
|
16292
16596
|
</dl>
|
|
16293
16597
|
</details>
|
|
16294
16598
|
|
|
16295
|
-
<details><summary><code>client.paypoint.<a href="/lib/payabli/paypoint/client.rb">
|
|
16599
|
+
<details><summary><code>client.paypoint.<a href="/lib/payabli/paypoint/client.rb">get_entry_config</a>(entry) -> Payabli::Paypoint::Types::GetEntryConfigResponse</code></summary>
|
|
16296
16600
|
<dl>
|
|
16297
16601
|
<dd>
|
|
16298
16602
|
|
|
@@ -16304,7 +16608,7 @@ client.paypoint.save_logo(entry: "8cfec329267")
|
|
|
16304
16608
|
<dl>
|
|
16305
16609
|
<dd>
|
|
16306
16610
|
|
|
16307
|
-
|
|
16611
|
+
Gets the details for a single paypoint.
|
|
16308
16612
|
</dd>
|
|
16309
16613
|
</dl>
|
|
16310
16614
|
</dd>
|
|
@@ -16319,7 +16623,7 @@ Retrieves an paypoint's basic settings like custom fields, identifiers, and invo
|
|
|
16319
16623
|
<dd>
|
|
16320
16624
|
|
|
16321
16625
|
```ruby
|
|
16322
|
-
client.paypoint.
|
|
16626
|
+
client.paypoint.get_entry_config(entry: "8cfec329267")
|
|
16323
16627
|
```
|
|
16324
16628
|
</dd>
|
|
16325
16629
|
</dl>
|
|
@@ -16342,6 +16646,14 @@ client.paypoint.settings_page(entry: "8cfec329267")
|
|
|
16342
16646
|
<dl>
|
|
16343
16647
|
<dd>
|
|
16344
16648
|
|
|
16649
|
+
**entrypages:** `String`
|
|
16650
|
+
|
|
16651
|
+
</dd>
|
|
16652
|
+
</dl>
|
|
16653
|
+
|
|
16654
|
+
<dl>
|
|
16655
|
+
<dd>
|
|
16656
|
+
|
|
16345
16657
|
**request_options:** `Payabli::Paypoint::RequestOptions`
|
|
16346
16658
|
|
|
16347
16659
|
</dd>
|
|
@@ -16354,7 +16666,7 @@ client.paypoint.settings_page(entry: "8cfec329267")
|
|
|
16354
16666
|
</dl>
|
|
16355
16667
|
</details>
|
|
16356
16668
|
|
|
16357
|
-
<details><summary><code>client.paypoint.<a href="/lib/payabli/paypoint/client.rb">
|
|
16669
|
+
<details><summary><code>client.paypoint.<a href="/lib/payabli/paypoint/client.rb">get_page</a>(entry, subdomain) -> Payabli::Types::PayabliPages</code></summary>
|
|
16358
16670
|
<dl>
|
|
16359
16671
|
<dd>
|
|
16360
16672
|
|
|
@@ -16366,7 +16678,7 @@ client.paypoint.settings_page(entry: "8cfec329267")
|
|
|
16366
16678
|
<dl>
|
|
16367
16679
|
<dd>
|
|
16368
16680
|
|
|
16369
|
-
|
|
16681
|
+
Gets the details for single payment page for a paypoint.
|
|
16370
16682
|
</dd>
|
|
16371
16683
|
</dl>
|
|
16372
16684
|
</dd>
|
|
@@ -16381,16 +16693,9 @@ Migrates a paypoint to a new parent organization.
|
|
|
16381
16693
|
<dd>
|
|
16382
16694
|
|
|
16383
16695
|
```ruby
|
|
16384
|
-
client.paypoint.
|
|
16385
|
-
|
|
16386
|
-
|
|
16387
|
-
notification_request: {
|
|
16388
|
-
notification_url: "https://webhook-test.yoursie.com",
|
|
16389
|
-
web_header_parameters: [{
|
|
16390
|
-
key: "testheader",
|
|
16391
|
-
value: "1234567890"
|
|
16392
|
-
}]
|
|
16393
|
-
}
|
|
16696
|
+
client.paypoint.get_page(
|
|
16697
|
+
entry: "8cfec329267",
|
|
16698
|
+
subdomain: "pay-your-fees-1"
|
|
16394
16699
|
)
|
|
16395
16700
|
```
|
|
16396
16701
|
</dd>
|
|
@@ -16406,7 +16711,15 @@ client.paypoint.migrate(
|
|
|
16406
16711
|
<dl>
|
|
16407
16712
|
<dd>
|
|
16408
16713
|
|
|
16409
|
-
**
|
|
16714
|
+
**entry:** `String` — The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
16715
|
+
|
|
16716
|
+
</dd>
|
|
16717
|
+
</dl>
|
|
16718
|
+
|
|
16719
|
+
<dl>
|
|
16720
|
+
<dd>
|
|
16721
|
+
|
|
16722
|
+
**subdomain:** `String` — Payment page identifier. The subdomain value is the last portion of the payment page URL. For example, in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
|
|
16410
16723
|
|
|
16411
16724
|
</dd>
|
|
16412
16725
|
</dl>
|
|
@@ -16426,8 +16739,7 @@ client.paypoint.migrate(
|
|
|
16426
16739
|
</dl>
|
|
16427
16740
|
</details>
|
|
16428
16741
|
|
|
16429
|
-
|
|
16430
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_batch_details</a>(entry) -> Payabli::QueryTypes::Types::QueryBatchesDetailResponse</code></summary>
|
|
16742
|
+
<details><summary><code>client.paypoint.<a href="/lib/payabli/paypoint/client.rb">remove_page</a>(entry, subdomain) -> Payabli::Types::PayabliApiResponseGeneric2Part</code></summary>
|
|
16431
16743
|
<dl>
|
|
16432
16744
|
<dd>
|
|
16433
16745
|
|
|
@@ -16439,8 +16751,7 @@ client.paypoint.migrate(
|
|
|
16439
16751
|
<dl>
|
|
16440
16752
|
<dd>
|
|
16441
16753
|
|
|
16442
|
-
|
|
16443
|
-
unsettled transactions for a paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
|
|
16754
|
+
Deletes a payment page in a paypoint.
|
|
16444
16755
|
</dd>
|
|
16445
16756
|
</dl>
|
|
16446
16757
|
</dd>
|
|
@@ -16455,11 +16766,9 @@ unsettled transactions for a paypoint. Use filters to limit results. Include the
|
|
|
16455
16766
|
<dd>
|
|
16456
16767
|
|
|
16457
16768
|
```ruby
|
|
16458
|
-
client.
|
|
16769
|
+
client.paypoint.remove_page(
|
|
16459
16770
|
entry: "8cfec329267",
|
|
16460
|
-
|
|
16461
|
-
limit_record: 0,
|
|
16462
|
-
sort_by: "desc(field_name)"
|
|
16771
|
+
subdomain: "pay-your-fees-1"
|
|
16463
16772
|
)
|
|
16464
16773
|
```
|
|
16465
16774
|
</dd>
|
|
@@ -16475,7 +16784,7 @@ client.query.list_batch_details(
|
|
|
16475
16784
|
<dl>
|
|
16476
16785
|
<dd>
|
|
16477
16786
|
|
|
16478
|
-
**entry:** `String`
|
|
16787
|
+
**entry:** `String` — The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
16479
16788
|
|
|
16480
16789
|
</dd>
|
|
16481
16790
|
</dl>
|
|
@@ -16483,7 +16792,7 @@ client.query.list_batch_details(
|
|
|
16483
16792
|
<dl>
|
|
16484
16793
|
<dd>
|
|
16485
16794
|
|
|
16486
|
-
**
|
|
16795
|
+
**subdomain:** `String` — Payment page identifier. The subdomain value is the last portion of the payment page URL. For example, in`https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1`, the subdomain is `pay-your-fees-1`.
|
|
16487
16796
|
|
|
16488
16797
|
</dd>
|
|
16489
16798
|
</dl>
|
|
@@ -16491,100 +16800,61 @@ client.query.list_batch_details(
|
|
|
16491
16800
|
<dl>
|
|
16492
16801
|
<dd>
|
|
16493
16802
|
|
|
16494
|
-
**
|
|
16803
|
+
**request_options:** `Payabli::Paypoint::RequestOptions`
|
|
16495
16804
|
|
|
16496
16805
|
</dd>
|
|
16497
16806
|
</dl>
|
|
16807
|
+
</dd>
|
|
16808
|
+
</dl>
|
|
16498
16809
|
|
|
16499
|
-
<dl>
|
|
16500
|
-
<dd>
|
|
16501
16810
|
|
|
16502
|
-
**limit_record:** `Integer` — Max number of records to return for the query. Use `0` or negative value to return all records.
|
|
16503
|
-
|
|
16504
16811
|
</dd>
|
|
16505
16812
|
</dl>
|
|
16813
|
+
</details>
|
|
16506
16814
|
|
|
16815
|
+
<details><summary><code>client.paypoint.<a href="/lib/payabli/paypoint/client.rb">save_logo</a>(entry, request) -> Payabli::Types::PayabliApiResponse00Responsedatanonobject</code></summary>
|
|
16507
16816
|
<dl>
|
|
16508
16817
|
<dd>
|
|
16509
16818
|
|
|
16510
|
-
|
|
16511
|
-
|
|
16512
|
-
|
|
16513
|
-
Collection of field names, conditions, and values used to filter the query.
|
|
16514
|
-
<Info>
|
|
16515
|
-
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
16516
|
-
|
|
16517
|
-
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client.
|
|
16819
|
+
#### 📝 Description
|
|
16518
16820
|
|
|
16519
|
-
|
|
16821
|
+
<dl>
|
|
16822
|
+
<dd>
|
|
16520
16823
|
|
|
16521
|
-
|
|
16824
|
+
<dl>
|
|
16825
|
+
<dd>
|
|
16522
16826
|
|
|
16523
|
-
|
|
16827
|
+
Updates a paypoint logo.
|
|
16828
|
+
</dd>
|
|
16829
|
+
</dl>
|
|
16830
|
+
</dd>
|
|
16831
|
+
</dl>
|
|
16524
16832
|
|
|
16525
|
-
|
|
16526
|
-
</Info>
|
|
16833
|
+
#### 🔌 Usage
|
|
16527
16834
|
|
|
16528
|
-
|
|
16835
|
+
<dl>
|
|
16836
|
+
<dd>
|
|
16529
16837
|
|
|
16530
|
-
|
|
16838
|
+
<dl>
|
|
16839
|
+
<dd>
|
|
16531
16840
|
|
|
16532
|
-
|
|
16533
|
-
|
|
16534
|
-
|
|
16535
|
-
|
|
16536
|
-
|
|
16537
|
-
|
|
16538
|
-
|
|
16539
|
-
- `source` (in, nin, eq, ne)
|
|
16540
|
-
- `batchNumber` (ct, nct, eq, ne)
|
|
16541
|
-
- `payaccountLastfour` (nct, ct)
|
|
16542
|
-
- `payaccountType` (ne, eq, in, nin)
|
|
16543
|
-
- `customerFirstname` (ct, nct, eq, ne)
|
|
16544
|
-
- `customerLastname` (ct, nct, eq, ne)
|
|
16545
|
-
- `customerName` (ct, nct)
|
|
16546
|
-
- `customerId` (eq, ne)
|
|
16547
|
-
- `customerNumber` (ct, nct, eq, ne)
|
|
16548
|
-
- `customerCompanyname` (ct, nct, eq, ne)
|
|
16549
|
-
- `customerAddress` (ct, nct, eq, ne)
|
|
16550
|
-
- `customerCity` (ct, nct, eq, ne)
|
|
16551
|
-
- `customerZip` (ct, nct, eq, ne)
|
|
16552
|
-
- `customerState` (ct, nct, eq, ne)
|
|
16553
|
-
- `customerCountry` (ct, nct, eq, ne)
|
|
16554
|
-
- `customerPhone` (ct, nct, eq, ne)
|
|
16555
|
-
- `customerEmail` (ct, nct, eq, ne)
|
|
16556
|
-
- `customerShippingAddress` (ct, nct, eq, ne)
|
|
16557
|
-
- `customerShippingCity` (ct, nct, eq, ne)
|
|
16558
|
-
- `customerShippingZip` (ct, nct, eq, ne)
|
|
16559
|
-
- `customerShippingState` (ct, nct, eq, ne)
|
|
16560
|
-
- `customerShippingCountry` (ct, nct, eq, ne)
|
|
16561
|
-
- `orgId` (eq) *mandatory when entry=org*
|
|
16562
|
-
- `isHold` (eq, ne)
|
|
16563
|
-
- `paypointId` (ne, eq)
|
|
16564
|
-
- `paypointLegal` (ne, eq, ct, nct)
|
|
16565
|
-
- `paypointDba` (ne, eq, ct, nct)
|
|
16566
|
-
- `orgName` (ne, eq, ct, nct)
|
|
16567
|
-
- `batchId` (ct, nct, eq, neq)
|
|
16568
|
-
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
16841
|
+
```ruby
|
|
16842
|
+
client.paypoint.save_logo(entry: "8cfec329267")
|
|
16843
|
+
```
|
|
16844
|
+
</dd>
|
|
16845
|
+
</dl>
|
|
16846
|
+
</dd>
|
|
16847
|
+
</dl>
|
|
16569
16848
|
|
|
16570
|
-
|
|
16571
|
-
- `eq` or empty => equal
|
|
16572
|
-
- `gt` => greater than
|
|
16573
|
-
- `ge` => greater or equal
|
|
16574
|
-
- `lt` => less than
|
|
16575
|
-
- `le` => less or equal
|
|
16576
|
-
- `ne` => not equal
|
|
16577
|
-
- `ct` => contains
|
|
16578
|
-
- `nct` => not contains
|
|
16579
|
-
- `in` => inside array separated by "|"
|
|
16580
|
-
- `nin` => not inside array separated by "|"
|
|
16849
|
+
#### ⚙️ Parameters
|
|
16581
16850
|
|
|
16582
|
-
|
|
16851
|
+
<dl>
|
|
16852
|
+
<dd>
|
|
16583
16853
|
|
|
16584
|
-
|
|
16585
|
-
|
|
16854
|
+
<dl>
|
|
16855
|
+
<dd>
|
|
16586
16856
|
|
|
16587
|
-
|
|
16857
|
+
**entry:** `String` — The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
16588
16858
|
|
|
16589
16859
|
</dd>
|
|
16590
16860
|
</dl>
|
|
@@ -16592,7 +16862,7 @@ Example: `settledAmount(gt)=20` returns all records with a `settledAmount` great
|
|
|
16592
16862
|
<dl>
|
|
16593
16863
|
<dd>
|
|
16594
16864
|
|
|
16595
|
-
**
|
|
16865
|
+
**request:** `Payabli::Types::FileContent`
|
|
16596
16866
|
|
|
16597
16867
|
</dd>
|
|
16598
16868
|
</dl>
|
|
@@ -16600,7 +16870,7 @@ Example: `settledAmount(gt)=20` returns all records with a `settledAmount` great
|
|
|
16600
16870
|
<dl>
|
|
16601
16871
|
<dd>
|
|
16602
16872
|
|
|
16603
|
-
**request_options:** `Payabli::
|
|
16873
|
+
**request_options:** `Payabli::Paypoint::RequestOptions`
|
|
16604
16874
|
|
|
16605
16875
|
</dd>
|
|
16606
16876
|
</dl>
|
|
@@ -16612,7 +16882,7 @@ Example: `settledAmount(gt)=20` returns all records with a `settledAmount` great
|
|
|
16612
16882
|
</dl>
|
|
16613
16883
|
</details>
|
|
16614
16884
|
|
|
16615
|
-
<details><summary><code>client.
|
|
16885
|
+
<details><summary><code>client.paypoint.<a href="/lib/payabli/paypoint/client.rb">settings_page</a>(entry) -> Payabli::Types::SettingsQueryRecord</code></summary>
|
|
16616
16886
|
<dl>
|
|
16617
16887
|
<dd>
|
|
16618
16888
|
|
|
@@ -16624,7 +16894,7 @@ Example: `settledAmount(gt)=20` returns all records with a `settledAmount` great
|
|
|
16624
16894
|
<dl>
|
|
16625
16895
|
<dd>
|
|
16626
16896
|
|
|
16627
|
-
|
|
16897
|
+
Retrieves an paypoint's basic settings like custom fields, identifiers, and invoicing settings.
|
|
16628
16898
|
</dd>
|
|
16629
16899
|
</dl>
|
|
16630
16900
|
</dd>
|
|
@@ -16639,8 +16909,144 @@ Retrieve a list of batches and their details, including settled and unsettled tr
|
|
|
16639
16909
|
<dd>
|
|
16640
16910
|
|
|
16641
16911
|
```ruby
|
|
16642
|
-
client.
|
|
16643
|
-
|
|
16912
|
+
client.paypoint.settings_page(entry: "8cfec329267")
|
|
16913
|
+
```
|
|
16914
|
+
</dd>
|
|
16915
|
+
</dl>
|
|
16916
|
+
</dd>
|
|
16917
|
+
</dl>
|
|
16918
|
+
|
|
16919
|
+
#### ⚙️ Parameters
|
|
16920
|
+
|
|
16921
|
+
<dl>
|
|
16922
|
+
<dd>
|
|
16923
|
+
|
|
16924
|
+
<dl>
|
|
16925
|
+
<dd>
|
|
16926
|
+
|
|
16927
|
+
**entry:** `String` — The paypoint's entrypoint identifier. [Learn more](/developers/api-reference/api-overview#entrypoint-vs-entry)
|
|
16928
|
+
|
|
16929
|
+
</dd>
|
|
16930
|
+
</dl>
|
|
16931
|
+
|
|
16932
|
+
<dl>
|
|
16933
|
+
<dd>
|
|
16934
|
+
|
|
16935
|
+
**request_options:** `Payabli::Paypoint::RequestOptions`
|
|
16936
|
+
|
|
16937
|
+
</dd>
|
|
16938
|
+
</dl>
|
|
16939
|
+
</dd>
|
|
16940
|
+
</dl>
|
|
16941
|
+
|
|
16942
|
+
|
|
16943
|
+
</dd>
|
|
16944
|
+
</dl>
|
|
16945
|
+
</details>
|
|
16946
|
+
|
|
16947
|
+
<details><summary><code>client.paypoint.<a href="/lib/payabli/paypoint/client.rb">migrate</a>(request) -> Payabli::Paypoint::Types::MigratePaypointResponse</code></summary>
|
|
16948
|
+
<dl>
|
|
16949
|
+
<dd>
|
|
16950
|
+
|
|
16951
|
+
#### 📝 Description
|
|
16952
|
+
|
|
16953
|
+
<dl>
|
|
16954
|
+
<dd>
|
|
16955
|
+
|
|
16956
|
+
<dl>
|
|
16957
|
+
<dd>
|
|
16958
|
+
|
|
16959
|
+
Migrates a paypoint to a new parent organization.
|
|
16960
|
+
</dd>
|
|
16961
|
+
</dl>
|
|
16962
|
+
</dd>
|
|
16963
|
+
</dl>
|
|
16964
|
+
|
|
16965
|
+
#### 🔌 Usage
|
|
16966
|
+
|
|
16967
|
+
<dl>
|
|
16968
|
+
<dd>
|
|
16969
|
+
|
|
16970
|
+
<dl>
|
|
16971
|
+
<dd>
|
|
16972
|
+
|
|
16973
|
+
```ruby
|
|
16974
|
+
client.paypoint.migrate(
|
|
16975
|
+
entry_point: "473abc123def",
|
|
16976
|
+
new_parent_organization_id: 123,
|
|
16977
|
+
notification_request: {
|
|
16978
|
+
notification_url: "https://webhook-test.yoursie.com",
|
|
16979
|
+
web_header_parameters: [{
|
|
16980
|
+
key: "testheader",
|
|
16981
|
+
value: "1234567890"
|
|
16982
|
+
}]
|
|
16983
|
+
}
|
|
16984
|
+
)
|
|
16985
|
+
```
|
|
16986
|
+
</dd>
|
|
16987
|
+
</dl>
|
|
16988
|
+
</dd>
|
|
16989
|
+
</dl>
|
|
16990
|
+
|
|
16991
|
+
#### ⚙️ Parameters
|
|
16992
|
+
|
|
16993
|
+
<dl>
|
|
16994
|
+
<dd>
|
|
16995
|
+
|
|
16996
|
+
<dl>
|
|
16997
|
+
<dd>
|
|
16998
|
+
|
|
16999
|
+
**request:** `Payabli::Paypoint::Types::PaypointMoveRequest`
|
|
17000
|
+
|
|
17001
|
+
</dd>
|
|
17002
|
+
</dl>
|
|
17003
|
+
|
|
17004
|
+
<dl>
|
|
17005
|
+
<dd>
|
|
17006
|
+
|
|
17007
|
+
**request_options:** `Payabli::Paypoint::RequestOptions`
|
|
17008
|
+
|
|
17009
|
+
</dd>
|
|
17010
|
+
</dl>
|
|
17011
|
+
</dd>
|
|
17012
|
+
</dl>
|
|
17013
|
+
|
|
17014
|
+
|
|
17015
|
+
</dd>
|
|
17016
|
+
</dl>
|
|
17017
|
+
</details>
|
|
17018
|
+
|
|
17019
|
+
## Query
|
|
17020
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_batch_details</a>(entry) -> Payabli::QueryTypes::Types::QueryBatchesDetailResponse</code></summary>
|
|
17021
|
+
<dl>
|
|
17022
|
+
<dd>
|
|
17023
|
+
|
|
17024
|
+
#### 📝 Description
|
|
17025
|
+
|
|
17026
|
+
<dl>
|
|
17027
|
+
<dd>
|
|
17028
|
+
|
|
17029
|
+
<dl>
|
|
17030
|
+
<dd>
|
|
17031
|
+
|
|
17032
|
+
Retrieve a list of batches and their details, including settled and
|
|
17033
|
+
unsettled transactions for a paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
|
|
17034
|
+
</dd>
|
|
17035
|
+
</dl>
|
|
17036
|
+
</dd>
|
|
17037
|
+
</dl>
|
|
17038
|
+
|
|
17039
|
+
#### 🔌 Usage
|
|
17040
|
+
|
|
17041
|
+
<dl>
|
|
17042
|
+
<dd>
|
|
17043
|
+
|
|
17044
|
+
<dl>
|
|
17045
|
+
<dd>
|
|
17046
|
+
|
|
17047
|
+
```ruby
|
|
17048
|
+
client.query.list_batch_details(
|
|
17049
|
+
entry: "8cfec329267",
|
|
16644
17050
|
from_record: 251,
|
|
16645
17051
|
limit_record: 0,
|
|
16646
17052
|
sort_by: "desc(field_name)"
|
|
@@ -16659,7 +17065,7 @@ client.query.list_batch_details_org(
|
|
|
16659
17065
|
<dl>
|
|
16660
17066
|
<dd>
|
|
16661
17067
|
|
|
16662
|
-
**
|
|
17068
|
+
**entry:** `String`
|
|
16663
17069
|
|
|
16664
17070
|
</dd>
|
|
16665
17071
|
</dl>
|
|
@@ -16708,6 +17114,7 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
16708
17114
|
|
|
16709
17115
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
16710
17116
|
</Info>
|
|
17117
|
+
|
|
16711
17118
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
16712
17119
|
|
|
16713
17120
|
**List of field names accepted:**
|
|
@@ -16795,7 +17202,7 @@ Example: `settledAmount(gt)=20` returns all records with a `settledAmount` great
|
|
|
16795
17202
|
</dl>
|
|
16796
17203
|
</details>
|
|
16797
17204
|
|
|
16798
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">
|
|
17205
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_batch_details_org</a>(org_id) -> Payabli::Types::QueryResponseSettlements</code></summary>
|
|
16799
17206
|
<dl>
|
|
16800
17207
|
<dd>
|
|
16801
17208
|
|
|
@@ -16807,7 +17214,7 @@ Example: `settledAmount(gt)=20` returns all records with a `settledAmount` great
|
|
|
16807
17214
|
<dl>
|
|
16808
17215
|
<dd>
|
|
16809
17216
|
|
|
16810
|
-
Retrieve a list of batches for
|
|
17217
|
+
Retrieve a list of batches and their details, including settled and unsettled transactions for an organization. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
|
|
16811
17218
|
</dd>
|
|
16812
17219
|
</dl>
|
|
16813
17220
|
</dd>
|
|
@@ -16822,8 +17229,8 @@ Retrieve a list of batches for a paypoint. Use filters to limit results. Include
|
|
|
16822
17229
|
<dd>
|
|
16823
17230
|
|
|
16824
17231
|
```ruby
|
|
16825
|
-
client.query.
|
|
16826
|
-
|
|
17232
|
+
client.query.list_batch_details_org(
|
|
17233
|
+
org_id: 123,
|
|
16827
17234
|
from_record: 251,
|
|
16828
17235
|
limit_record: 0,
|
|
16829
17236
|
sort_by: "desc(field_name)"
|
|
@@ -16842,7 +17249,7 @@ client.query.list_batches(
|
|
|
16842
17249
|
<dl>
|
|
16843
17250
|
<dd>
|
|
16844
17251
|
|
|
16845
|
-
**
|
|
17252
|
+
**org_id:** `Integer` — The numeric identifier for organization, assigned by Payabli.
|
|
16846
17253
|
|
|
16847
17254
|
</dd>
|
|
16848
17255
|
</dl>
|
|
@@ -16876,6 +17283,7 @@ client.query.list_batches(
|
|
|
16876
17283
|
|
|
16877
17284
|
**parameters:** `Internal::Types::Hash[String, String]`
|
|
16878
17285
|
|
|
17286
|
+
|
|
16879
17287
|
Collection of field names, conditions, and values used to filter the query.
|
|
16880
17288
|
<Info>
|
|
16881
17289
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
@@ -16890,46 +17298,66 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
16890
17298
|
|
|
16891
17299
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
16892
17300
|
</Info>
|
|
16893
|
-
|
|
16894
17301
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
16895
17302
|
|
|
16896
17303
|
**List of field names accepted:**
|
|
16897
17304
|
|
|
16898
|
-
- `
|
|
16899
|
-
- `batchNumber` (ne, eq)
|
|
16900
|
-
- `method` (in, nin, eq, ne)
|
|
16901
|
-
- `connectorName` (ne, eq, ct, nct)
|
|
16902
|
-
- `batchAmount` (gt, ge, lt, le, eq, ne)
|
|
16903
|
-
- `feeBatchAmount` (gt, ge, lt, le, eq, ne)
|
|
16904
|
-
- `netBatchAmount` (gt, ge, lt, le, eq, ne)
|
|
16905
|
-
- `releaseAmount` (gt, ge, lt, le, eq, ne)
|
|
16906
|
-
- `heldAmount` (gt, ge, lt, le, eq, ne)
|
|
16907
|
-
- `status` (in, nin, eq, ne)
|
|
16908
|
-
- `paypointLegal` (ne, eq, ct, nct)
|
|
16909
|
-
- `paypointDba` (ne, eq, ct, nct)
|
|
16910
|
-
- `orgName` (ne, eq, ct, nct)
|
|
16911
|
-
- `paypointId` (ne, eq)
|
|
16912
|
-
- `externalPaypointID` (ct, nct, eq, ne)
|
|
16913
|
-
- `expectedDepositDate` (gt, ge, lt, le, eq, ne)
|
|
17305
|
+
- `settlementDate` (gt, ge, lt, le, eq, ne)
|
|
16914
17306
|
- `depositDate` (gt, ge, lt, le, eq, ne)
|
|
16915
|
-
- `
|
|
16916
|
-
- `
|
|
16917
|
-
- `
|
|
16918
|
-
- `
|
|
16919
|
-
- `
|
|
16920
|
-
- `
|
|
16921
|
-
- `
|
|
16922
|
-
- `
|
|
16923
|
-
- `
|
|
16924
|
-
- `
|
|
16925
|
-
- `
|
|
16926
|
-
- `
|
|
17307
|
+
- `transId` (ne, eq, ct, nct)
|
|
17308
|
+
- `gatewayTransId` (ne, eq, ct, nct)
|
|
17309
|
+
- `method` (in, nin, eq, ne)
|
|
17310
|
+
- `settledAmount` (gt, ge, lt, le, eq, ne)
|
|
17311
|
+
- `operation` (in, nin, eq, ne)
|
|
17312
|
+
- `source` (in, nin, eq, ne)
|
|
17313
|
+
- `batchNumber` (ct, nct, eq, ne)
|
|
17314
|
+
- `payaccountLastfour` (nct, ct)
|
|
17315
|
+
- `payaccountType` (ne, eq, in, nin)
|
|
17316
|
+
- `customerFirstname` (ct, nct, eq, ne)
|
|
17317
|
+
- `customerLastname` (ct, nct, eq, ne)
|
|
17318
|
+
- `customerName` (ct, nct)
|
|
17319
|
+
- `customerId` (eq, ne)
|
|
17320
|
+
- `customerNumber` (ct, nct, eq, ne)
|
|
17321
|
+
- `customerCompanyname` (ct, nct, eq, ne)
|
|
17322
|
+
- `customerAddress` (ct, nct, eq, ne)
|
|
17323
|
+
- `customerCity` (ct, nct, eq, ne)
|
|
17324
|
+
- `customerZip` (ct, nct, eq, ne)
|
|
17325
|
+
- `customerState` (ct, nct, eq, ne)
|
|
17326
|
+
- `customerCountry` (ct, nct, eq, ne)
|
|
17327
|
+
- `customerPhone` (ct, nct, eq, ne)
|
|
17328
|
+
- `customerEmail` (ct, nct, eq, ne)
|
|
17329
|
+
- `customerShippingAddress` (ct, nct, eq, ne)
|
|
17330
|
+
- `customerShippingCity` (ct, nct, eq, ne)
|
|
17331
|
+
- `customerShippingZip` (ct, nct, eq, ne)
|
|
17332
|
+
- `customerShippingState` (ct, nct, eq, ne)
|
|
17333
|
+
- `customerShippingCountry` (ct, nct, eq, ne)
|
|
17334
|
+
- `orgId` (eq) *mandatory when entry=org*
|
|
17335
|
+
- `isHold` (eq, ne)
|
|
17336
|
+
- `paypointId` (ne, eq)
|
|
17337
|
+
- `paypointLegal` (ne, eq, ct, nct)
|
|
17338
|
+
- `paypointDba` (ne, eq, ct, nct)
|
|
17339
|
+
- `orgName` (ne, eq, ct, nct)
|
|
17340
|
+
- `batchId` (ct, nct, eq, neq)
|
|
17341
|
+
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
17342
|
+
|
|
17343
|
+
**List of comparison accepted:**
|
|
17344
|
+
- `eq` or empty => equal
|
|
17345
|
+
- `gt` => greater than
|
|
17346
|
+
- `ge` => greater or equal
|
|
17347
|
+
- `lt` => less than
|
|
17348
|
+
- `le` => less or equal
|
|
17349
|
+
- `ne` => not equal
|
|
17350
|
+
- `ct` => contains
|
|
17351
|
+
- `nct` => not contains
|
|
17352
|
+
- `in` => inside array separated by "|"
|
|
17353
|
+
- `nin` => not inside array separated by "|"
|
|
16927
17354
|
|
|
16928
17355
|
**List of parameters accepted:**
|
|
17356
|
+
|
|
16929
17357
|
- `limitRecord`: max number of records for query (default="20", "0" or negative value for all)
|
|
16930
17358
|
- `fromRecord`: initial record in query
|
|
16931
17359
|
|
|
16932
|
-
Example: `
|
|
17360
|
+
Example: `settledAmount(gt)=20` returns all records with a `settledAmount` greater than 20.00.
|
|
16933
17361
|
|
|
16934
17362
|
</dd>
|
|
16935
17363
|
</dl>
|
|
@@ -16957,7 +17385,7 @@ Example: `batchAmount(gt)=20` returns all records with a `batchAmount` greater t
|
|
|
16957
17385
|
</dl>
|
|
16958
17386
|
</details>
|
|
16959
17387
|
|
|
16960
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">
|
|
17388
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_batches</a>(entry) -> Payabli::QueryTypes::Types::QueryBatchesResponse</code></summary>
|
|
16961
17389
|
<dl>
|
|
16962
17390
|
<dd>
|
|
16963
17391
|
|
|
@@ -16969,7 +17397,7 @@ Example: `batchAmount(gt)=20` returns all records with a `batchAmount` greater t
|
|
|
16969
17397
|
<dl>
|
|
16970
17398
|
<dd>
|
|
16971
17399
|
|
|
16972
|
-
Retrieve a list of batches for
|
|
17400
|
+
Retrieve a list of batches for a paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
|
|
16973
17401
|
</dd>
|
|
16974
17402
|
</dl>
|
|
16975
17403
|
</dd>
|
|
@@ -16984,8 +17412,8 @@ Retrieve a list of batches for an org. Use filters to limit results. Include the
|
|
|
16984
17412
|
<dd>
|
|
16985
17413
|
|
|
16986
17414
|
```ruby
|
|
16987
|
-
client.query.
|
|
16988
|
-
|
|
17415
|
+
client.query.list_batches(
|
|
17416
|
+
entry: "8cfec329267",
|
|
16989
17417
|
from_record: 251,
|
|
16990
17418
|
limit_record: 0,
|
|
16991
17419
|
sort_by: "desc(field_name)"
|
|
@@ -17004,7 +17432,7 @@ client.query.list_batches_org(
|
|
|
17004
17432
|
<dl>
|
|
17005
17433
|
<dd>
|
|
17006
17434
|
|
|
17007
|
-
**
|
|
17435
|
+
**entry:** `String`
|
|
17008
17436
|
|
|
17009
17437
|
</dd>
|
|
17010
17438
|
</dl>
|
|
@@ -17119,7 +17547,7 @@ Example: `batchAmount(gt)=20` returns all records with a `batchAmount` greater t
|
|
|
17119
17547
|
</dl>
|
|
17120
17548
|
</details>
|
|
17121
17549
|
|
|
17122
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">
|
|
17550
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_batches_org</a>(org_id) -> Payabli::QueryTypes::Types::QueryBatchesResponse</code></summary>
|
|
17123
17551
|
<dl>
|
|
17124
17552
|
<dd>
|
|
17125
17553
|
|
|
@@ -17131,7 +17559,7 @@ Example: `batchAmount(gt)=20` returns all records with a `batchAmount` greater t
|
|
|
17131
17559
|
<dl>
|
|
17132
17560
|
<dd>
|
|
17133
17561
|
|
|
17134
|
-
Retrieve a list of
|
|
17562
|
+
Retrieve a list of batches for an org. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
|
|
17135
17563
|
</dd>
|
|
17136
17564
|
</dl>
|
|
17137
17565
|
</dd>
|
|
@@ -17146,8 +17574,170 @@ Retrieve a list of MoneyOut batches for a paypoint. Use filters to limit results
|
|
|
17146
17574
|
<dd>
|
|
17147
17575
|
|
|
17148
17576
|
```ruby
|
|
17149
|
-
client.query.
|
|
17150
|
-
|
|
17577
|
+
client.query.list_batches_org(
|
|
17578
|
+
org_id: 123,
|
|
17579
|
+
from_record: 251,
|
|
17580
|
+
limit_record: 0,
|
|
17581
|
+
sort_by: "desc(field_name)"
|
|
17582
|
+
)
|
|
17583
|
+
```
|
|
17584
|
+
</dd>
|
|
17585
|
+
</dl>
|
|
17586
|
+
</dd>
|
|
17587
|
+
</dl>
|
|
17588
|
+
|
|
17589
|
+
#### ⚙️ Parameters
|
|
17590
|
+
|
|
17591
|
+
<dl>
|
|
17592
|
+
<dd>
|
|
17593
|
+
|
|
17594
|
+
<dl>
|
|
17595
|
+
<dd>
|
|
17596
|
+
|
|
17597
|
+
**org_id:** `Integer` — The numeric identifier for organization, assigned by Payabli.
|
|
17598
|
+
|
|
17599
|
+
</dd>
|
|
17600
|
+
</dl>
|
|
17601
|
+
|
|
17602
|
+
<dl>
|
|
17603
|
+
<dd>
|
|
17604
|
+
|
|
17605
|
+
**export_format:** `Payabli::Types::ExportFormat`
|
|
17606
|
+
|
|
17607
|
+
</dd>
|
|
17608
|
+
</dl>
|
|
17609
|
+
|
|
17610
|
+
<dl>
|
|
17611
|
+
<dd>
|
|
17612
|
+
|
|
17613
|
+
**from_record:** `Integer` — The number of records to skip before starting to collect the result set.
|
|
17614
|
+
|
|
17615
|
+
</dd>
|
|
17616
|
+
</dl>
|
|
17617
|
+
|
|
17618
|
+
<dl>
|
|
17619
|
+
<dd>
|
|
17620
|
+
|
|
17621
|
+
**limit_record:** `Integer` — Max number of records to return for the query. Use `0` or negative value to return all records.
|
|
17622
|
+
|
|
17623
|
+
</dd>
|
|
17624
|
+
</dl>
|
|
17625
|
+
|
|
17626
|
+
<dl>
|
|
17627
|
+
<dd>
|
|
17628
|
+
|
|
17629
|
+
**parameters:** `Internal::Types::Hash[String, String]`
|
|
17630
|
+
|
|
17631
|
+
Collection of field names, conditions, and values used to filter the query.
|
|
17632
|
+
<Info>
|
|
17633
|
+
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
17634
|
+
|
|
17635
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client.
|
|
17636
|
+
|
|
17637
|
+
For example:
|
|
17638
|
+
|
|
17639
|
+
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
17640
|
+
|
|
17641
|
+
should become:
|
|
17642
|
+
|
|
17643
|
+
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
17644
|
+
</Info>
|
|
17645
|
+
|
|
17646
|
+
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
17647
|
+
|
|
17648
|
+
**List of field names accepted:**
|
|
17649
|
+
|
|
17650
|
+
- `batchDate` (gt, ge, lt, le, eq, ne)
|
|
17651
|
+
- `batchNumber` (ne, eq)
|
|
17652
|
+
- `method` (in, nin, eq, ne)
|
|
17653
|
+
- `connectorName` (ne, eq, ct, nct)
|
|
17654
|
+
- `batchAmount` (gt, ge, lt, le, eq, ne)
|
|
17655
|
+
- `feeBatchAmount` (gt, ge, lt, le, eq, ne)
|
|
17656
|
+
- `netBatchAmount` (gt, ge, lt, le, eq, ne)
|
|
17657
|
+
- `releaseAmount` (gt, ge, lt, le, eq, ne)
|
|
17658
|
+
- `heldAmount` (gt, ge, lt, le, eq, ne)
|
|
17659
|
+
- `status` (in, nin, eq, ne)
|
|
17660
|
+
- `paypointLegal` (ne, eq, ct, nct)
|
|
17661
|
+
- `paypointDba` (ne, eq, ct, nct)
|
|
17662
|
+
- `orgName` (ne, eq, ct, nct)
|
|
17663
|
+
- `paypointId` (ne, eq)
|
|
17664
|
+
- `externalPaypointID` (ct, nct, eq, ne)
|
|
17665
|
+
- `expectedDepositDate` (gt, ge, lt, le, eq, ne)
|
|
17666
|
+
- `depositDate` (gt, ge, lt, le, eq, ne)
|
|
17667
|
+
- `batchRecords` (gt, ge, lt, le, eq, ne)
|
|
17668
|
+
- `transferId` (ne, eq)
|
|
17669
|
+
- `transferDate` (gt, ge, lt, le, eq, ne)
|
|
17670
|
+
- `grossAmount` (gt, ge, lt, le, eq, ne)
|
|
17671
|
+
- `chargeBackAmount` (gt, ge, lt, le, eq, ne)
|
|
17672
|
+
- `returnedAmount` (gt, ge, lt, le, eq, ne)
|
|
17673
|
+
- `billingFeeAmount` (gt, ge, lt, le, eq, ne)
|
|
17674
|
+
- `thirdPartyPaidAmount` (gt, ge, lt, le, eq, ne)
|
|
17675
|
+
- `netFundedAmount` (gt, ge, lt, le, eq, ne)
|
|
17676
|
+
- `adjustmentAmount` (gt, ge, lt, le, eq, ne)
|
|
17677
|
+
- `processor` (ne, eq, ct, nct)
|
|
17678
|
+
- `transferStatus` (ne, eq, in, nin)
|
|
17679
|
+
|
|
17680
|
+
**List of parameters accepted:**
|
|
17681
|
+
- `limitRecord`: max number of records for query (default="20", "0" or negative value for all)
|
|
17682
|
+
- `fromRecord`: initial record in query
|
|
17683
|
+
|
|
17684
|
+
Example: `batchAmount(gt)=20` returns all records with a `batchAmount` greater than 20.00
|
|
17685
|
+
|
|
17686
|
+
</dd>
|
|
17687
|
+
</dl>
|
|
17688
|
+
|
|
17689
|
+
<dl>
|
|
17690
|
+
<dd>
|
|
17691
|
+
|
|
17692
|
+
**sort_by:** `String` — The field name to use for sorting results. Use `desc(field_name)` to sort descending by `field_name`, and use `asc(field_name)` to sort ascending by `field_name`.
|
|
17693
|
+
|
|
17694
|
+
</dd>
|
|
17695
|
+
</dl>
|
|
17696
|
+
|
|
17697
|
+
<dl>
|
|
17698
|
+
<dd>
|
|
17699
|
+
|
|
17700
|
+
**request_options:** `Payabli::Query::RequestOptions`
|
|
17701
|
+
|
|
17702
|
+
</dd>
|
|
17703
|
+
</dl>
|
|
17704
|
+
</dd>
|
|
17705
|
+
</dl>
|
|
17706
|
+
|
|
17707
|
+
|
|
17708
|
+
</dd>
|
|
17709
|
+
</dl>
|
|
17710
|
+
</details>
|
|
17711
|
+
|
|
17712
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_batches_out</a>(entry) -> Payabli::Types::QueryBatchesOutResponse</code></summary>
|
|
17713
|
+
<dl>
|
|
17714
|
+
<dd>
|
|
17715
|
+
|
|
17716
|
+
#### 📝 Description
|
|
17717
|
+
|
|
17718
|
+
<dl>
|
|
17719
|
+
<dd>
|
|
17720
|
+
|
|
17721
|
+
<dl>
|
|
17722
|
+
<dd>
|
|
17723
|
+
|
|
17724
|
+
Retrieve a list of MoneyOut batches for a paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
|
|
17725
|
+
</dd>
|
|
17726
|
+
</dl>
|
|
17727
|
+
</dd>
|
|
17728
|
+
</dl>
|
|
17729
|
+
|
|
17730
|
+
#### 🔌 Usage
|
|
17731
|
+
|
|
17732
|
+
<dl>
|
|
17733
|
+
<dd>
|
|
17734
|
+
|
|
17735
|
+
<dl>
|
|
17736
|
+
<dd>
|
|
17737
|
+
|
|
17738
|
+
```ruby
|
|
17739
|
+
client.query.list_batches_out(
|
|
17740
|
+
entry: "8cfec329267",
|
|
17151
17741
|
from_record: 251,
|
|
17152
17742
|
limit_record: 0,
|
|
17153
17743
|
sort_by: "desc(field_name)"
|
|
@@ -19340,7 +19930,375 @@ Example: `dbaname(ct)=hoa` returns all records with a `dbaname` containing "hoa"
|
|
|
19340
19930
|
</dl>
|
|
19341
19931
|
</details>
|
|
19342
19932
|
|
|
19343
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_settlements</a>(entry) -> Payabli::Types::QueryResponseSettlements</code></summary>
|
|
19933
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_settlements</a>(entry) -> Payabli::Types::QueryResponseSettlements</code></summary>
|
|
19934
|
+
<dl>
|
|
19935
|
+
<dd>
|
|
19936
|
+
|
|
19937
|
+
#### 📝 Description
|
|
19938
|
+
|
|
19939
|
+
<dl>
|
|
19940
|
+
<dd>
|
|
19941
|
+
|
|
19942
|
+
<dl>
|
|
19943
|
+
<dd>
|
|
19944
|
+
|
|
19945
|
+
Retrieve a list of settled transactions for a paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
|
|
19946
|
+
</dd>
|
|
19947
|
+
</dl>
|
|
19948
|
+
</dd>
|
|
19949
|
+
</dl>
|
|
19950
|
+
|
|
19951
|
+
#### 🔌 Usage
|
|
19952
|
+
|
|
19953
|
+
<dl>
|
|
19954
|
+
<dd>
|
|
19955
|
+
|
|
19956
|
+
<dl>
|
|
19957
|
+
<dd>
|
|
19958
|
+
|
|
19959
|
+
```ruby
|
|
19960
|
+
client.query.list_settlements(
|
|
19961
|
+
entry: "8cfec329267",
|
|
19962
|
+
from_record: 251,
|
|
19963
|
+
limit_record: 0,
|
|
19964
|
+
sort_by: "desc(field_name)"
|
|
19965
|
+
)
|
|
19966
|
+
```
|
|
19967
|
+
</dd>
|
|
19968
|
+
</dl>
|
|
19969
|
+
</dd>
|
|
19970
|
+
</dl>
|
|
19971
|
+
|
|
19972
|
+
#### ⚙️ Parameters
|
|
19973
|
+
|
|
19974
|
+
<dl>
|
|
19975
|
+
<dd>
|
|
19976
|
+
|
|
19977
|
+
<dl>
|
|
19978
|
+
<dd>
|
|
19979
|
+
|
|
19980
|
+
**entry:** `String`
|
|
19981
|
+
|
|
19982
|
+
</dd>
|
|
19983
|
+
</dl>
|
|
19984
|
+
|
|
19985
|
+
<dl>
|
|
19986
|
+
<dd>
|
|
19987
|
+
|
|
19988
|
+
**export_format:** `Payabli::Types::ExportFormat`
|
|
19989
|
+
|
|
19990
|
+
</dd>
|
|
19991
|
+
</dl>
|
|
19992
|
+
|
|
19993
|
+
<dl>
|
|
19994
|
+
<dd>
|
|
19995
|
+
|
|
19996
|
+
**from_record:** `Integer` — The number of records to skip before starting to collect the result set.
|
|
19997
|
+
|
|
19998
|
+
</dd>
|
|
19999
|
+
</dl>
|
|
20000
|
+
|
|
20001
|
+
<dl>
|
|
20002
|
+
<dd>
|
|
20003
|
+
|
|
20004
|
+
**limit_record:** `Integer` — Max number of records to return for the query. Use `0` or negative value to return all records.
|
|
20005
|
+
|
|
20006
|
+
</dd>
|
|
20007
|
+
</dl>
|
|
20008
|
+
|
|
20009
|
+
<dl>
|
|
20010
|
+
<dd>
|
|
20011
|
+
|
|
20012
|
+
**parameters:** `Internal::Types::Hash[String, String]`
|
|
20013
|
+
|
|
20014
|
+
|
|
20015
|
+
Collection of field names, conditions, and values used to filter the query.
|
|
20016
|
+
<Info>
|
|
20017
|
+
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
20018
|
+
|
|
20019
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client.
|
|
20020
|
+
|
|
20021
|
+
For example:
|
|
20022
|
+
|
|
20023
|
+
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
20024
|
+
|
|
20025
|
+
should become:
|
|
20026
|
+
|
|
20027
|
+
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
20028
|
+
</Info>
|
|
20029
|
+
|
|
20030
|
+
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
20031
|
+
|
|
20032
|
+
**List of field names accepted:**
|
|
20033
|
+
|
|
20034
|
+
- `settlementDate` (gt, ge, lt, le, eq, ne)
|
|
20035
|
+
- `depositDate` (gt, ge, lt, le, eq, ne)
|
|
20036
|
+
- `transId` (ne, eq, ct, nct)
|
|
20037
|
+
- `gatewayTransId` (ne, eq, ct, nct)
|
|
20038
|
+
- `method` (in, nin, eq, ne)
|
|
20039
|
+
- `settledAmount` (gt, ge, lt, le, eq, ne)
|
|
20040
|
+
- `operation` (in, nin, eq, ne)
|
|
20041
|
+
- `source` (in, nin, eq, ne)
|
|
20042
|
+
- `batchNumber` (ct, nct, eq, ne)
|
|
20043
|
+
- `payaccountLastfour` (nct, ct)
|
|
20044
|
+
- `payaccountType` (ne, eq, in, nin)
|
|
20045
|
+
- `customerFirstname` (ct, nct, eq, ne)
|
|
20046
|
+
- `customerLastname` (ct, nct, eq, ne)
|
|
20047
|
+
- `customerName` (ct, nct)
|
|
20048
|
+
- `customerId` (eq, ne)
|
|
20049
|
+
- `customerNumber` (ct, nct, eq, ne)
|
|
20050
|
+
- `customerCompanyname` (ct, nct, eq, ne)
|
|
20051
|
+
- `customerAddress` (ct, nct, eq, ne)
|
|
20052
|
+
- `customerCity` (ct, nct, eq, ne)
|
|
20053
|
+
- `customerZip` (ct, nct, eq, ne)
|
|
20054
|
+
- `customerState` (ct, nct, eq, ne)
|
|
20055
|
+
- `customerCountry` (ct, nct, eq, ne)
|
|
20056
|
+
- `customerPhone` (ct, nct, eq, ne)
|
|
20057
|
+
- `customerEmail` (ct, nct, eq, ne)
|
|
20058
|
+
- `customerShippingAddress` (ct, nct, eq, ne)
|
|
20059
|
+
- `customerShippingCity` (ct, nct, eq, ne)
|
|
20060
|
+
- `customerShippingZip` (ct, nct, eq, ne)
|
|
20061
|
+
- `customerShippingState` (ct, nct, eq, ne)
|
|
20062
|
+
- `customerShippingCountry` (ct, nct, eq, ne)
|
|
20063
|
+
- `orgId` (eq) *mandatory when entry=org*
|
|
20064
|
+
- `isHold` (eq, ne)
|
|
20065
|
+
- `paypointId` (ne, eq)
|
|
20066
|
+
- `paypointLegal` (ne, eq, ct, nct)
|
|
20067
|
+
- `paypointDba` (ne, eq, ct, nct)
|
|
20068
|
+
- `orgName` (ne, eq, ct, nct)
|
|
20069
|
+
- `batchId` (ct, nct, eq, neq)
|
|
20070
|
+
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
20071
|
+
|
|
20072
|
+
**List of comparison accepted:**
|
|
20073
|
+
- `eq` or empty => equal
|
|
20074
|
+
- `gt` => greater than
|
|
20075
|
+
- `ge` => greater or equal
|
|
20076
|
+
- `lt` => less than
|
|
20077
|
+
- `le` => less or equal
|
|
20078
|
+
- `ne` => not equal
|
|
20079
|
+
- `ct` => contains
|
|
20080
|
+
- `nct` => not contains
|
|
20081
|
+
- `in` => inside array separated by "|"
|
|
20082
|
+
- `nin` => not inside array separated by "|"
|
|
20083
|
+
|
|
20084
|
+
**List of parameters accepted:**
|
|
20085
|
+
|
|
20086
|
+
- `limitRecord`: max number of records for query (default="20", "0" or negative value for all)
|
|
20087
|
+
- `fromRecord`: initial record in query
|
|
20088
|
+
|
|
20089
|
+
Example: `settledAmount(gt)=20` returns all records with a `settledAmount` greater than 20.00.
|
|
20090
|
+
|
|
20091
|
+
</dd>
|
|
20092
|
+
</dl>
|
|
20093
|
+
|
|
20094
|
+
<dl>
|
|
20095
|
+
<dd>
|
|
20096
|
+
|
|
20097
|
+
**sort_by:** `String` — The field name to use for sorting results. Use `desc(field_name)` to sort descending by `field_name`, and use `asc(field_name)` to sort ascending by `field_name`.
|
|
20098
|
+
|
|
20099
|
+
</dd>
|
|
20100
|
+
</dl>
|
|
20101
|
+
|
|
20102
|
+
<dl>
|
|
20103
|
+
<dd>
|
|
20104
|
+
|
|
20105
|
+
**request_options:** `Payabli::Query::RequestOptions`
|
|
20106
|
+
|
|
20107
|
+
</dd>
|
|
20108
|
+
</dl>
|
|
20109
|
+
</dd>
|
|
20110
|
+
</dl>
|
|
20111
|
+
|
|
20112
|
+
|
|
20113
|
+
</dd>
|
|
20114
|
+
</dl>
|
|
20115
|
+
</details>
|
|
20116
|
+
|
|
20117
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_settlements_org</a>(org_id) -> Payabli::Types::QueryResponseSettlements</code></summary>
|
|
20118
|
+
<dl>
|
|
20119
|
+
<dd>
|
|
20120
|
+
|
|
20121
|
+
#### 📝 Description
|
|
20122
|
+
|
|
20123
|
+
<dl>
|
|
20124
|
+
<dd>
|
|
20125
|
+
|
|
20126
|
+
<dl>
|
|
20127
|
+
<dd>
|
|
20128
|
+
|
|
20129
|
+
Retrieve a list of settled transactions for an organization. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
|
|
20130
|
+
</dd>
|
|
20131
|
+
</dl>
|
|
20132
|
+
</dd>
|
|
20133
|
+
</dl>
|
|
20134
|
+
|
|
20135
|
+
#### 🔌 Usage
|
|
20136
|
+
|
|
20137
|
+
<dl>
|
|
20138
|
+
<dd>
|
|
20139
|
+
|
|
20140
|
+
<dl>
|
|
20141
|
+
<dd>
|
|
20142
|
+
|
|
20143
|
+
```ruby
|
|
20144
|
+
client.query.list_settlements_org(
|
|
20145
|
+
org_id: 123,
|
|
20146
|
+
from_record: 251,
|
|
20147
|
+
limit_record: 0,
|
|
20148
|
+
sort_by: "desc(field_name)"
|
|
20149
|
+
)
|
|
20150
|
+
```
|
|
20151
|
+
</dd>
|
|
20152
|
+
</dl>
|
|
20153
|
+
</dd>
|
|
20154
|
+
</dl>
|
|
20155
|
+
|
|
20156
|
+
#### ⚙️ Parameters
|
|
20157
|
+
|
|
20158
|
+
<dl>
|
|
20159
|
+
<dd>
|
|
20160
|
+
|
|
20161
|
+
<dl>
|
|
20162
|
+
<dd>
|
|
20163
|
+
|
|
20164
|
+
**org_id:** `Integer` — The numeric identifier for organization, assigned by Payabli.
|
|
20165
|
+
|
|
20166
|
+
</dd>
|
|
20167
|
+
</dl>
|
|
20168
|
+
|
|
20169
|
+
<dl>
|
|
20170
|
+
<dd>
|
|
20171
|
+
|
|
20172
|
+
**export_format:** `Payabli::Types::ExportFormat`
|
|
20173
|
+
|
|
20174
|
+
</dd>
|
|
20175
|
+
</dl>
|
|
20176
|
+
|
|
20177
|
+
<dl>
|
|
20178
|
+
<dd>
|
|
20179
|
+
|
|
20180
|
+
**from_record:** `Integer` — The number of records to skip before starting to collect the result set.
|
|
20181
|
+
|
|
20182
|
+
</dd>
|
|
20183
|
+
</dl>
|
|
20184
|
+
|
|
20185
|
+
<dl>
|
|
20186
|
+
<dd>
|
|
20187
|
+
|
|
20188
|
+
**limit_record:** `Integer` — Max number of records to return for the query. Use `0` or negative value to return all records.
|
|
20189
|
+
|
|
20190
|
+
</dd>
|
|
20191
|
+
</dl>
|
|
20192
|
+
|
|
20193
|
+
<dl>
|
|
20194
|
+
<dd>
|
|
20195
|
+
|
|
20196
|
+
**parameters:** `Internal::Types::Hash[String, String]`
|
|
20197
|
+
|
|
20198
|
+
|
|
20199
|
+
Collection of field names, conditions, and values used to filter the query.
|
|
20200
|
+
<Info>
|
|
20201
|
+
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
20202
|
+
|
|
20203
|
+
Because of a technical limitation, you can't make a request that includes filters from the API console on this page. The response won't be filtered. Instead, copy the request, remove `parameters=` and run the request in a different client.
|
|
20204
|
+
|
|
20205
|
+
For example:
|
|
20206
|
+
|
|
20207
|
+
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
20208
|
+
|
|
20209
|
+
should become:
|
|
20210
|
+
|
|
20211
|
+
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
20212
|
+
</Info>
|
|
20213
|
+
|
|
20214
|
+
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
20215
|
+
|
|
20216
|
+
**List of field names accepted:**
|
|
20217
|
+
|
|
20218
|
+
- `settlementDate` (gt, ge, lt, le, eq, ne)
|
|
20219
|
+
- `depositDate` (gt, ge, lt, le, eq, ne)
|
|
20220
|
+
- `transId` (ne, eq, ct, nct)
|
|
20221
|
+
- `gatewayTransId` (ne, eq, ct, nct)
|
|
20222
|
+
- `method` (in, nin, eq, ne)
|
|
20223
|
+
- `settledAmount` (gt, ge, lt, le, eq, ne)
|
|
20224
|
+
- `operation` (in, nin, eq, ne)
|
|
20225
|
+
- `source` (in, nin, eq, ne)
|
|
20226
|
+
- `batchNumber` (ct, nct, eq, ne)
|
|
20227
|
+
- `payaccountLastfour` (nct, ct)
|
|
20228
|
+
- `payaccountType` (ne, eq, in, nin)
|
|
20229
|
+
- `customerFirstname` (ct, nct, eq, ne)
|
|
20230
|
+
- `customerLastname` (ct, nct, eq, ne)
|
|
20231
|
+
- `customerName` (ct, nct)
|
|
20232
|
+
- `customerId` (eq, ne)
|
|
20233
|
+
- `customerNumber` (ct, nct, eq, ne)
|
|
20234
|
+
- `customerCompanyname` (ct, nct, eq, ne)
|
|
20235
|
+
- `customerAddress` (ct, nct, eq, ne)
|
|
20236
|
+
- `customerCity` (ct, nct, eq, ne)
|
|
20237
|
+
- `customerZip` (ct, nct, eq, ne)
|
|
20238
|
+
- `customerState` (ct, nct, eq, ne)
|
|
20239
|
+
- `customerCountry` (ct, nct, eq, ne)
|
|
20240
|
+
- `customerPhone` (ct, nct, eq, ne)
|
|
20241
|
+
- `customerEmail` (ct, nct, eq, ne)
|
|
20242
|
+
- `customerShippingAddress` (ct, nct, eq, ne)
|
|
20243
|
+
- `customerShippingCity` (ct, nct, eq, ne)
|
|
20244
|
+
- `customerShippingZip` (ct, nct, eq, ne)
|
|
20245
|
+
- `customerShippingState` (ct, nct, eq, ne)
|
|
20246
|
+
- `customerShippingCountry` (ct, nct, eq, ne)
|
|
20247
|
+
- `orgId` (eq) *mandatory when entry=org*
|
|
20248
|
+
- `isHold` (eq, ne)
|
|
20249
|
+
- `paypointId` (ne, eq)
|
|
20250
|
+
- `paypointLegal` (ne, eq, ct, nct)
|
|
20251
|
+
- `paypointDba` (ne, eq, ct, nct)
|
|
20252
|
+
- `orgName` (ne, eq, ct, nct)
|
|
20253
|
+
- `batchId` (ct, nct, eq, neq)
|
|
20254
|
+
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
20255
|
+
|
|
20256
|
+
**List of comparison accepted:**
|
|
20257
|
+
- `eq` or empty => equal
|
|
20258
|
+
- `gt` => greater than
|
|
20259
|
+
- `ge` => greater or equal
|
|
20260
|
+
- `lt` => less than
|
|
20261
|
+
- `le` => less or equal
|
|
20262
|
+
- `ne` => not equal
|
|
20263
|
+
- `ct` => contains
|
|
20264
|
+
- `nct` => not contains
|
|
20265
|
+
- `in` => inside array separated by "|"
|
|
20266
|
+
- `nin` => not inside array separated by "|"
|
|
20267
|
+
|
|
20268
|
+
**List of parameters accepted:**
|
|
20269
|
+
|
|
20270
|
+
- `limitRecord`: max number of records for query (default="20", "0" or negative value for all)
|
|
20271
|
+
- `fromRecord`: initial record in query
|
|
20272
|
+
|
|
20273
|
+
Example: `settledAmount(gt)=20` returns all records with a `settledAmount` greater than 20.00.
|
|
20274
|
+
|
|
20275
|
+
</dd>
|
|
20276
|
+
</dl>
|
|
20277
|
+
|
|
20278
|
+
<dl>
|
|
20279
|
+
<dd>
|
|
20280
|
+
|
|
20281
|
+
**sort_by:** `String` — The field name to use for sorting results. Use `desc(field_name)` to sort descending by `field_name`, and use `asc(field_name)` to sort ascending by `field_name`.
|
|
20282
|
+
|
|
20283
|
+
</dd>
|
|
20284
|
+
</dl>
|
|
20285
|
+
|
|
20286
|
+
<dl>
|
|
20287
|
+
<dd>
|
|
20288
|
+
|
|
20289
|
+
**request_options:** `Payabli::Query::RequestOptions`
|
|
20290
|
+
|
|
20291
|
+
</dd>
|
|
20292
|
+
</dl>
|
|
20293
|
+
</dd>
|
|
20294
|
+
</dl>
|
|
20295
|
+
|
|
20296
|
+
|
|
20297
|
+
</dd>
|
|
20298
|
+
</dl>
|
|
20299
|
+
</details>
|
|
20300
|
+
|
|
20301
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_subscriptions</a>(entry) -> Payabli::Types::QuerySubscriptionResponse</code></summary>
|
|
19344
20302
|
<dl>
|
|
19345
20303
|
<dd>
|
|
19346
20304
|
|
|
@@ -19352,7 +20310,7 @@ Example: `dbaname(ct)=hoa` returns all records with a `dbaname` containing "hoa"
|
|
|
19352
20310
|
<dl>
|
|
19353
20311
|
<dd>
|
|
19354
20312
|
|
|
19355
|
-
|
|
20313
|
+
Returns a list of subscriptions for a single paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
|
|
19356
20314
|
</dd>
|
|
19357
20315
|
</dl>
|
|
19358
20316
|
</dd>
|
|
@@ -19367,7 +20325,7 @@ Retrieve a list of settled transactions for a paypoint. Use filters to limit res
|
|
|
19367
20325
|
<dd>
|
|
19368
20326
|
|
|
19369
20327
|
```ruby
|
|
19370
|
-
client.query.
|
|
20328
|
+
client.query.list_subscriptions(
|
|
19371
20329
|
entry: "8cfec329267",
|
|
19372
20330
|
from_record: 251,
|
|
19373
20331
|
limit_record: 0,
|
|
@@ -19436,50 +20394,57 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
19436
20394
|
|
|
19437
20395
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
19438
20396
|
</Info>
|
|
19439
|
-
|
|
19440
20397
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
19441
|
-
|
|
20398
|
+
|
|
19442
20399
|
**List of field names accepted:**
|
|
19443
20400
|
|
|
19444
|
-
- `
|
|
19445
|
-
- `
|
|
19446
|
-
- `
|
|
19447
|
-
- `
|
|
19448
|
-
- `method`
|
|
19449
|
-
- `
|
|
19450
|
-
- `
|
|
19451
|
-
- `
|
|
19452
|
-
- `
|
|
19453
|
-
- `
|
|
19454
|
-
- `
|
|
19455
|
-
- `
|
|
19456
|
-
- `
|
|
19457
|
-
- `
|
|
19458
|
-
- `
|
|
19459
|
-
- `
|
|
19460
|
-
- `
|
|
20401
|
+
- `startDate` (gt, ge, lt, le, eq, ne)
|
|
20402
|
+
- `endDate` (gt, ge, lt, le, eq, ne)
|
|
20403
|
+
- `nextDate` (gt, ge, lt, le, eq, ne)
|
|
20404
|
+
- `frequency` (in, nin, ne, eq)
|
|
20405
|
+
- `method` (in, nin, eq, ne)
|
|
20406
|
+
- `totalAmount` (gt, ge, lt, le, eq, ne)
|
|
20407
|
+
- `netAmount` (gt, ge, lt, le, eq, ne)
|
|
20408
|
+
- `feeAmount` (gt, ge, lt, le, eq, ne)
|
|
20409
|
+
- `status` (in, nin, eq, ne)
|
|
20410
|
+
- `untilcancelled` (eq, ne)
|
|
20411
|
+
- `payaccountLastfour` (nct, ct)
|
|
20412
|
+
- `payaccountType` (ne, eq, in, nin)
|
|
20413
|
+
- `payaccountCurrency` (ne, eq, in, nin)
|
|
20414
|
+
- `customerFirstname` (ct, nct, eq, ne)
|
|
20415
|
+
- `customerLastname` (ct, nct, eq, ne)
|
|
20416
|
+
- `customerName` (ct, nct)
|
|
20417
|
+
- `customerId` (eq, ne)
|
|
20418
|
+
- `customerNumber` (ct, nct, eq, ne)
|
|
20419
|
+
- `customerCompanyname` (ct, nct, eq, ne)
|
|
19461
20420
|
- `customerAddress` (ct, nct, eq, ne)
|
|
19462
|
-
- `customerCity`
|
|
20421
|
+
- `customerCity` (ct, nct, eq, ne)
|
|
19463
20422
|
- `customerZip` (ct, nct, eq, ne)
|
|
19464
20423
|
- `customerState` (ct, nct, eq, ne)
|
|
19465
20424
|
- `customerCountry` (ct, nct, eq, ne)
|
|
19466
20425
|
- `customerPhone` (ct, nct, eq, ne)
|
|
19467
20426
|
- `customerEmail` (ct, nct, eq, ne)
|
|
19468
20427
|
- `customerShippingAddress` (ct, nct, eq, ne)
|
|
19469
|
-
- `customerShippingCity`
|
|
20428
|
+
- `customerShippingCity` (ct, nct, eq, ne)
|
|
19470
20429
|
- `customerShippingZip` (ct, nct, eq, ne)
|
|
19471
20430
|
- `customerShippingState` (ct, nct, eq, ne)
|
|
19472
20431
|
- `customerShippingCountry` (ct, nct, eq, ne)
|
|
19473
|
-
- `orgId`
|
|
19474
|
-
- `
|
|
19475
|
-
- `
|
|
19476
|
-
- `
|
|
19477
|
-
- `
|
|
19478
|
-
- `
|
|
19479
|
-
- `
|
|
19480
|
-
- `
|
|
20432
|
+
- `orgId` (eq)
|
|
20433
|
+
- `paypointId` (ne, eq)
|
|
20434
|
+
- `paypointLegal` (ne, eq, ct, nct)
|
|
20435
|
+
- `paypointDba` (ne, eq, ct, nct)
|
|
20436
|
+
- `orgName` (ne, eq, ct, nct)
|
|
20437
|
+
- `externalPaypointId` (ct, nct, ne, eq)
|
|
20438
|
+
- `subId` (eq, ne)
|
|
20439
|
+
- `orderDescription` (ct, nct)
|
|
20440
|
+
- `cycles` (eq, ne, gt, ge, lt, le)
|
|
20441
|
+
- `leftcycles` (eq, ne, gt, ge, lt, le)
|
|
20442
|
+
- `createdAt` (eq, ne, gt, ge, lt, le)
|
|
20443
|
+
- `updatedOn` (eq, ne, gt, ge, lt, le)
|
|
20444
|
+
- `invoiceNumber` (ct, nct)
|
|
20445
|
+
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
19481
20446
|
|
|
19482
|
-
**List of comparison accepted:**
|
|
20447
|
+
**List of comparison operators accepted:**
|
|
19483
20448
|
- `eq` or empty => equal
|
|
19484
20449
|
- `gt` => greater than
|
|
19485
20450
|
- `ge` => greater or equal
|
|
@@ -19488,15 +20453,8 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
19488
20453
|
- `ne` => not equal
|
|
19489
20454
|
- `ct` => contains
|
|
19490
20455
|
- `nct` => not contains
|
|
19491
|
-
- `in` => inside array
|
|
19492
|
-
- `nin` => not inside array
|
|
19493
|
-
|
|
19494
|
-
**List of parameters accepted:**
|
|
19495
|
-
|
|
19496
|
-
- `limitRecord`: max number of records for query (default="20", "0" or negative value for all)
|
|
19497
|
-
- `fromRecord`: initial record in query
|
|
19498
|
-
|
|
19499
|
-
Example: `settledAmount(gt)=20` returns all records with a `settledAmount` greater than 20.00.
|
|
20456
|
+
- `in` => inside array
|
|
20457
|
+
- `nin` => not inside array
|
|
19500
20458
|
|
|
19501
20459
|
</dd>
|
|
19502
20460
|
</dl>
|
|
@@ -19524,7 +20482,7 @@ Example: `settledAmount(gt)=20` returns all records with a `settledAmount` great
|
|
|
19524
20482
|
</dl>
|
|
19525
20483
|
</details>
|
|
19526
20484
|
|
|
19527
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">
|
|
20485
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_subscriptions_org</a>(org_id) -> Payabli::Types::QuerySubscriptionResponse</code></summary>
|
|
19528
20486
|
<dl>
|
|
19529
20487
|
<dd>
|
|
19530
20488
|
|
|
@@ -19536,7 +20494,7 @@ Example: `settledAmount(gt)=20` returns all records with a `settledAmount` great
|
|
|
19536
20494
|
<dl>
|
|
19537
20495
|
<dd>
|
|
19538
20496
|
|
|
19539
|
-
|
|
20497
|
+
Returns a list of subscriptions for a single org. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
|
|
19540
20498
|
</dd>
|
|
19541
20499
|
</dl>
|
|
19542
20500
|
</dd>
|
|
@@ -19551,7 +20509,7 @@ Retrieve a list of settled transactions for an organization. Include the `export
|
|
|
19551
20509
|
<dd>
|
|
19552
20510
|
|
|
19553
20511
|
```ruby
|
|
19554
|
-
client.query.
|
|
20512
|
+
client.query.list_subscriptions_org(
|
|
19555
20513
|
org_id: 123,
|
|
19556
20514
|
from_record: 251,
|
|
19557
20515
|
limit_record: 0,
|
|
@@ -19620,50 +20578,57 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
19620
20578
|
|
|
19621
20579
|
--url https://api-sandbox.payabli.com/api/Query/transactions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
19622
20580
|
</Info>
|
|
19623
|
-
|
|
19624
20581
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
19625
|
-
|
|
20582
|
+
|
|
19626
20583
|
**List of field names accepted:**
|
|
19627
20584
|
|
|
19628
|
-
- `
|
|
19629
|
-
- `
|
|
19630
|
-
- `
|
|
19631
|
-
- `
|
|
19632
|
-
- `method`
|
|
19633
|
-
- `
|
|
19634
|
-
- `
|
|
19635
|
-
- `
|
|
19636
|
-
- `
|
|
19637
|
-
- `
|
|
19638
|
-
- `
|
|
19639
|
-
- `
|
|
19640
|
-
- `
|
|
19641
|
-
- `
|
|
19642
|
-
- `
|
|
19643
|
-
- `
|
|
19644
|
-
- `
|
|
20585
|
+
- `startDate` (gt, ge, lt, le, eq, ne)
|
|
20586
|
+
- `endDate` (gt, ge, lt, le, eq, ne)
|
|
20587
|
+
- `nextDate` (gt, ge, lt, le, eq, ne)
|
|
20588
|
+
- `frequency` (in, nin, ne, eq)
|
|
20589
|
+
- `method` (in, nin, eq, ne)
|
|
20590
|
+
- `totalAmount` (gt, ge, lt, le, eq, ne)
|
|
20591
|
+
- `netAmount` (gt, ge, lt, le, eq, ne)
|
|
20592
|
+
- `feeAmount` (gt, ge, lt, le, eq, ne)
|
|
20593
|
+
- `status` (in, nin, eq, ne)
|
|
20594
|
+
- `untilcancelled` (eq, ne)
|
|
20595
|
+
- `payaccountLastfour` (nct, ct)
|
|
20596
|
+
- `payaccountType` (ne, eq, in, nin)
|
|
20597
|
+
- `payaccountCurrency` (ne, eq, in, nin)
|
|
20598
|
+
- `customerFirstname` (ct, nct, eq, ne)
|
|
20599
|
+
- `customerLastname` (ct, nct, eq, ne)
|
|
20600
|
+
- `customerName` (ct, nct)
|
|
20601
|
+
- `customerId` (eq, ne)
|
|
20602
|
+
- `customerNumber` (ct, nct, eq, ne)
|
|
20603
|
+
- `customerCompanyname` (ct, nct, eq, ne)
|
|
19645
20604
|
- `customerAddress` (ct, nct, eq, ne)
|
|
19646
|
-
- `customerCity`
|
|
20605
|
+
- `customerCity` (ct, nct, eq, ne)
|
|
19647
20606
|
- `customerZip` (ct, nct, eq, ne)
|
|
19648
20607
|
- `customerState` (ct, nct, eq, ne)
|
|
19649
20608
|
- `customerCountry` (ct, nct, eq, ne)
|
|
19650
20609
|
- `customerPhone` (ct, nct, eq, ne)
|
|
19651
20610
|
- `customerEmail` (ct, nct, eq, ne)
|
|
19652
20611
|
- `customerShippingAddress` (ct, nct, eq, ne)
|
|
19653
|
-
- `customerShippingCity`
|
|
20612
|
+
- `customerShippingCity` (ct, nct, eq, ne)
|
|
19654
20613
|
- `customerShippingZip` (ct, nct, eq, ne)
|
|
19655
20614
|
- `customerShippingState` (ct, nct, eq, ne)
|
|
19656
20615
|
- `customerShippingCountry` (ct, nct, eq, ne)
|
|
19657
|
-
- `orgId`
|
|
19658
|
-
- `
|
|
19659
|
-
- `
|
|
19660
|
-
- `
|
|
19661
|
-
- `
|
|
19662
|
-
- `
|
|
19663
|
-
- `
|
|
19664
|
-
- `
|
|
20616
|
+
- `orgId` (eq)
|
|
20617
|
+
- `paypointId` (ne, eq)
|
|
20618
|
+
- `paypointLegal` (ne, eq, ct, nct)
|
|
20619
|
+
- `paypointDba` (ne, eq, ct, nct)
|
|
20620
|
+
- `orgName` (ne, eq, ct, nct)
|
|
20621
|
+
- `externalPaypointId` (ct, nct, ne, eq)
|
|
20622
|
+
- `subId` (eq, ne)
|
|
20623
|
+
- `orderDescription` (ct, nct)
|
|
20624
|
+
- `cycles` (eq, ne, gt, ge, lt, le)
|
|
20625
|
+
- `leftcycles` (eq, ne, gt, ge, lt, le)
|
|
20626
|
+
- `createdAt` (eq, ne, gt, ge, lt, le)
|
|
20627
|
+
- `updatedOn` (eq, ne, gt, ge, lt, le)
|
|
20628
|
+
- `invoiceNumber` (ct, nct)
|
|
20629
|
+
- `additional-xxx` (ne, eq, ct, nct) where xxx is the additional field name
|
|
19665
20630
|
|
|
19666
|
-
**List of comparison accepted:**
|
|
20631
|
+
**List of comparison operators accepted:**
|
|
19667
20632
|
- `eq` or empty => equal
|
|
19668
20633
|
- `gt` => greater than
|
|
19669
20634
|
- `ge` => greater or equal
|
|
@@ -19672,15 +20637,8 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
19672
20637
|
- `ne` => not equal
|
|
19673
20638
|
- `ct` => contains
|
|
19674
20639
|
- `nct` => not contains
|
|
19675
|
-
- `in` => inside array
|
|
19676
|
-
- `nin` => not inside array
|
|
19677
|
-
|
|
19678
|
-
**List of parameters accepted:**
|
|
19679
|
-
|
|
19680
|
-
- `limitRecord`: max number of records for query (default="20", "0" or negative value for all)
|
|
19681
|
-
- `fromRecord`: initial record in query
|
|
19682
|
-
|
|
19683
|
-
Example: `settledAmount(gt)=20` returns all records with a `settledAmount` greater than 20.00.
|
|
20640
|
+
- `in` => inside array
|
|
20641
|
+
- `nin` => not inside array
|
|
19684
20642
|
|
|
19685
20643
|
</dd>
|
|
19686
20644
|
</dl>
|
|
@@ -19708,7 +20666,7 @@ Example: `settledAmount(gt)=20` returns all records with a `settledAmount` great
|
|
|
19708
20666
|
</dl>
|
|
19709
20667
|
</details>
|
|
19710
20668
|
|
|
19711
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">
|
|
20669
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_payout_subscriptions</a>(entry) -> Payabli::PayoutSubscription::Types::QueryPayoutSubscriptionResponse</code></summary>
|
|
19712
20670
|
<dl>
|
|
19713
20671
|
<dd>
|
|
19714
20672
|
|
|
@@ -19720,7 +20678,7 @@ Example: `settledAmount(gt)=20` returns all records with a `settledAmount` great
|
|
|
19720
20678
|
<dl>
|
|
19721
20679
|
<dd>
|
|
19722
20680
|
|
|
19723
|
-
Returns a list of subscriptions for a single paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
|
|
20681
|
+
Returns a list of payout subscriptions for a single paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
|
|
19724
20682
|
</dd>
|
|
19725
20683
|
</dl>
|
|
19726
20684
|
</dd>
|
|
@@ -19735,10 +20693,10 @@ Returns a list of subscriptions for a single paypoint. Use filters to limit resu
|
|
|
19735
20693
|
<dd>
|
|
19736
20694
|
|
|
19737
20695
|
```ruby
|
|
19738
|
-
client.query.
|
|
20696
|
+
client.query.list_payout_subscriptions(
|
|
19739
20697
|
entry: "8cfec329267",
|
|
19740
|
-
from_record:
|
|
19741
|
-
limit_record:
|
|
20698
|
+
from_record: 0,
|
|
20699
|
+
limit_record: 20,
|
|
19742
20700
|
sort_by: "desc(field_name)"
|
|
19743
20701
|
)
|
|
19744
20702
|
```
|
|
@@ -19790,7 +20748,7 @@ client.query.list_subscriptions(
|
|
|
19790
20748
|
**parameters:** `Internal::Types::Hash[String, String]`
|
|
19791
20749
|
|
|
19792
20750
|
|
|
19793
|
-
Collection of field names, conditions, and values used to filter the query.
|
|
20751
|
+
Collection of field names, conditions, and values used to filter the query.
|
|
19794
20752
|
<Info>
|
|
19795
20753
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
19796
20754
|
|
|
@@ -19798,14 +20756,13 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
19798
20756
|
|
|
19799
20757
|
For example:
|
|
19800
20758
|
|
|
19801
|
-
--url https://api-sandbox.payabli.com/api/Query/
|
|
20759
|
+
--url https://api-sandbox.payabli.com/api/Query/payoutsubscriptions/entry123?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
19802
20760
|
|
|
19803
20761
|
should become:
|
|
19804
20762
|
|
|
19805
|
-
--url https://api-sandbox.payabli.com/api/Query/
|
|
20763
|
+
--url https://api-sandbox.payabli.com/api/Query/payoutsubscriptions/entry123?totalAmount(gt)=1000&limitRecord=20
|
|
19806
20764
|
</Info>
|
|
19807
20765
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
19808
|
-
|
|
19809
20766
|
**List of field names accepted:**
|
|
19810
20767
|
|
|
19811
20768
|
- `startDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -19818,41 +20775,30 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
19818
20775
|
- `feeAmount` (gt, ge, lt, le, eq, ne)
|
|
19819
20776
|
- `status` (in, nin, eq, ne)
|
|
19820
20777
|
- `untilcancelled` (eq, ne)
|
|
19821
|
-
- `payaccountLastfour` (
|
|
20778
|
+
- `payaccountLastfour` (ct, nct)
|
|
19822
20779
|
- `payaccountType` (ne, eq, in, nin)
|
|
19823
20780
|
- `payaccountCurrency` (ne, eq, in, nin)
|
|
19824
|
-
- `customerFirstname` (ct, nct, eq, ne)
|
|
19825
|
-
- `customerLastname` (ct, nct, eq, ne)
|
|
19826
|
-
- `customerName` (ct, nct)
|
|
19827
|
-
- `customerId` (eq, ne)
|
|
19828
|
-
- `customerNumber` (ct, nct, eq, ne)
|
|
19829
|
-
- `customerCompanyname` (ct, nct, eq, ne)
|
|
19830
|
-
- `customerAddress` (ct, nct, eq, ne)
|
|
19831
|
-
- `customerCity` (ct, nct, eq, ne)
|
|
19832
|
-
- `customerZip` (ct, nct, eq, ne)
|
|
19833
|
-
- `customerState` (ct, nct, eq, ne)
|
|
19834
|
-
- `customerCountry` (ct, nct, eq, ne)
|
|
19835
|
-
- `customerPhone` (ct, nct, eq, ne)
|
|
19836
|
-
- `customerEmail` (ct, nct, eq, ne)
|
|
19837
|
-
- `customerShippingAddress` (ct, nct, eq, ne)
|
|
19838
|
-
- `customerShippingCity` (ct, nct, eq, ne)
|
|
19839
|
-
- `customerShippingZip` (ct, nct, eq, ne)
|
|
19840
|
-
- `customerShippingState` (ct, nct, eq, ne)
|
|
19841
|
-
- `customerShippingCountry` (ct, nct, eq, ne)
|
|
19842
|
-
- `orgId` (eq)
|
|
19843
20781
|
- `paypointId` (ne, eq)
|
|
19844
20782
|
- `paypointLegal` (ne, eq, ct, nct)
|
|
19845
20783
|
- `paypointDba` (ne, eq, ct, nct)
|
|
19846
|
-
- `orgName` (ne, eq, ct, nct)
|
|
19847
|
-
- `
|
|
19848
|
-
- `
|
|
20784
|
+
- `orgName` (ne, eq, ct, nct, nin, in)
|
|
20785
|
+
- `parentOrgId` (ne, eq, nin, in)
|
|
20786
|
+
- `subscriptionId` (eq, ne)
|
|
19849
20787
|
- `orderDescription` (ct, nct)
|
|
19850
20788
|
- `cycles` (eq, ne, gt, ge, lt, le)
|
|
19851
20789
|
- `leftcycles` (eq, ne, gt, ge, lt, le)
|
|
19852
20790
|
- `createdAt` (eq, ne, gt, ge, lt, le)
|
|
19853
20791
|
- `updatedOn` (eq, ne, gt, ge, lt, le)
|
|
19854
|
-
- `
|
|
19855
|
-
- `
|
|
20792
|
+
- `vendorNumber` (ne, eq, ct, nct)
|
|
20793
|
+
- `name` (ne, eq, ct, nct)
|
|
20794
|
+
- `phone` (ne, eq, ct, nct)
|
|
20795
|
+
- `email` (ne, eq, ct, nct)
|
|
20796
|
+
- `address` (ne, eq, ct, nct)
|
|
20797
|
+
- `remitAddress` (ct, nct)
|
|
20798
|
+
- `city` (ne, eq, ct, nct)
|
|
20799
|
+
- `state` (ne, eq, ct, nct)
|
|
20800
|
+
- `country` (ne, eq, ct, nct)
|
|
20801
|
+
- `zip` (ne, eq, ct, nct)
|
|
19856
20802
|
|
|
19857
20803
|
**List of comparison operators accepted:**
|
|
19858
20804
|
- `eq` or empty => equal
|
|
@@ -19892,7 +20838,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
19892
20838
|
</dl>
|
|
19893
20839
|
</details>
|
|
19894
20840
|
|
|
19895
|
-
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">
|
|
20841
|
+
<details><summary><code>client.query.<a href="/lib/payabli/query/client.rb">list_payout_subscriptions_org</a>(org_id) -> Payabli::PayoutSubscription::Types::QueryPayoutSubscriptionResponse</code></summary>
|
|
19896
20842
|
<dl>
|
|
19897
20843
|
<dd>
|
|
19898
20844
|
|
|
@@ -19904,7 +20850,7 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
19904
20850
|
<dl>
|
|
19905
20851
|
<dd>
|
|
19906
20852
|
|
|
19907
|
-
Returns a list of subscriptions for a single org. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
|
|
20853
|
+
Returns a list of payout subscriptions for a single org. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response. See [Manage payout subscriptions](/guides/pay-out-developer-payout-subscriptions-manage) for more information.
|
|
19908
20854
|
</dd>
|
|
19909
20855
|
</dl>
|
|
19910
20856
|
</dd>
|
|
@@ -19919,10 +20865,10 @@ Returns a list of subscriptions for a single org. Use filters to limit results.
|
|
|
19919
20865
|
<dd>
|
|
19920
20866
|
|
|
19921
20867
|
```ruby
|
|
19922
|
-
client.query.
|
|
20868
|
+
client.query.list_payout_subscriptions_org(
|
|
19923
20869
|
org_id: 123,
|
|
19924
|
-
from_record:
|
|
19925
|
-
limit_record:
|
|
20870
|
+
from_record: 0,
|
|
20871
|
+
limit_record: 20,
|
|
19926
20872
|
sort_by: "desc(field_name)"
|
|
19927
20873
|
)
|
|
19928
20874
|
```
|
|
@@ -19974,7 +20920,7 @@ client.query.list_subscriptions_org(
|
|
|
19974
20920
|
**parameters:** `Internal::Types::Hash[String, String]`
|
|
19975
20921
|
|
|
19976
20922
|
|
|
19977
|
-
Collection of field names, conditions, and values used to filter the query.
|
|
20923
|
+
Collection of field names, conditions, and values used to filter the query.
|
|
19978
20924
|
<Info>
|
|
19979
20925
|
**You must remove `parameters=` from the request before you send it, otherwise Payabli will ignore the filters.**
|
|
19980
20926
|
|
|
@@ -19982,14 +20928,13 @@ Collection of field names, conditions, and values used to filter the query.
|
|
|
19982
20928
|
|
|
19983
20929
|
For example:
|
|
19984
20930
|
|
|
19985
|
-
--url https://api-sandbox.payabli.com/api/Query/
|
|
20931
|
+
--url https://api-sandbox.payabli.com/api/Query/payoutsubscriptions/org/236?parameters=totalAmount(gt)=1000&limitRecord=20
|
|
19986
20932
|
|
|
19987
20933
|
should become:
|
|
19988
20934
|
|
|
19989
|
-
--url https://api-sandbox.payabli.com/api/Query/
|
|
20935
|
+
--url https://api-sandbox.payabli.com/api/Query/payoutsubscriptions/org/236?totalAmount(gt)=1000&limitRecord=20
|
|
19990
20936
|
</Info>
|
|
19991
20937
|
See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-reporting-engine-overview#filters-and-conditions-reference) for more information.
|
|
19992
|
-
|
|
19993
20938
|
**List of field names accepted:**
|
|
19994
20939
|
|
|
19995
20940
|
- `startDate` (gt, ge, lt, le, eq, ne)
|
|
@@ -20002,41 +20947,30 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
20002
20947
|
- `feeAmount` (gt, ge, lt, le, eq, ne)
|
|
20003
20948
|
- `status` (in, nin, eq, ne)
|
|
20004
20949
|
- `untilcancelled` (eq, ne)
|
|
20005
|
-
- `payaccountLastfour` (
|
|
20950
|
+
- `payaccountLastfour` (ct, nct)
|
|
20006
20951
|
- `payaccountType` (ne, eq, in, nin)
|
|
20007
20952
|
- `payaccountCurrency` (ne, eq, in, nin)
|
|
20008
|
-
- `customerFirstname` (ct, nct, eq, ne)
|
|
20009
|
-
- `customerLastname` (ct, nct, eq, ne)
|
|
20010
|
-
- `customerName` (ct, nct)
|
|
20011
|
-
- `customerId` (eq, ne)
|
|
20012
|
-
- `customerNumber` (ct, nct, eq, ne)
|
|
20013
|
-
- `customerCompanyname` (ct, nct, eq, ne)
|
|
20014
|
-
- `customerAddress` (ct, nct, eq, ne)
|
|
20015
|
-
- `customerCity` (ct, nct, eq, ne)
|
|
20016
|
-
- `customerZip` (ct, nct, eq, ne)
|
|
20017
|
-
- `customerState` (ct, nct, eq, ne)
|
|
20018
|
-
- `customerCountry` (ct, nct, eq, ne)
|
|
20019
|
-
- `customerPhone` (ct, nct, eq, ne)
|
|
20020
|
-
- `customerEmail` (ct, nct, eq, ne)
|
|
20021
|
-
- `customerShippingAddress` (ct, nct, eq, ne)
|
|
20022
|
-
- `customerShippingCity` (ct, nct, eq, ne)
|
|
20023
|
-
- `customerShippingZip` (ct, nct, eq, ne)
|
|
20024
|
-
- `customerShippingState` (ct, nct, eq, ne)
|
|
20025
|
-
- `customerShippingCountry` (ct, nct, eq, ne)
|
|
20026
|
-
- `orgId` (eq)
|
|
20027
20953
|
- `paypointId` (ne, eq)
|
|
20028
20954
|
- `paypointLegal` (ne, eq, ct, nct)
|
|
20029
20955
|
- `paypointDba` (ne, eq, ct, nct)
|
|
20030
|
-
- `orgName` (ne, eq, ct, nct)
|
|
20031
|
-
- `
|
|
20032
|
-
- `
|
|
20956
|
+
- `orgName` (ne, eq, ct, nct, nin, in)
|
|
20957
|
+
- `parentOrgId` (ne, eq, nin, in)
|
|
20958
|
+
- `subscriptionId` (eq, ne)
|
|
20033
20959
|
- `orderDescription` (ct, nct)
|
|
20034
20960
|
- `cycles` (eq, ne, gt, ge, lt, le)
|
|
20035
20961
|
- `leftcycles` (eq, ne, gt, ge, lt, le)
|
|
20036
20962
|
- `createdAt` (eq, ne, gt, ge, lt, le)
|
|
20037
20963
|
- `updatedOn` (eq, ne, gt, ge, lt, le)
|
|
20038
|
-
- `
|
|
20039
|
-
- `
|
|
20964
|
+
- `vendorNumber` (ne, eq, ct, nct)
|
|
20965
|
+
- `name` (ne, eq, ct, nct)
|
|
20966
|
+
- `phone` (ne, eq, ct, nct)
|
|
20967
|
+
- `email` (ne, eq, ct, nct)
|
|
20968
|
+
- `address` (ne, eq, ct, nct)
|
|
20969
|
+
- `remitAddress` (ct, nct)
|
|
20970
|
+
- `city` (ne, eq, ct, nct)
|
|
20971
|
+
- `state` (ne, eq, ct, nct)
|
|
20972
|
+
- `country` (ne, eq, ct, nct)
|
|
20973
|
+
- `zip` (ne, eq, ct, nct)
|
|
20040
20974
|
|
|
20041
20975
|
**List of comparison operators accepted:**
|
|
20042
20976
|
- `eq` or empty => equal
|
|
@@ -20091,9 +21025,8 @@ See [Filters and Conditions Reference](/developers/developer-guides/pay-ops-repo
|
|
|
20091
21025
|
Retrieve a list of transactions for a paypoint. Use filters to limit results. Include the `exportFormat` query parameter to return the results as a file instead of a JSON response.
|
|
20092
21026
|
By default, this endpoint returns only transactions from the last 60 days. To query transactions outside of this period, include `transactionDate` filters.
|
|
20093
21027
|
For example, this request parameters filter for transactions between April 01, 2024 and April 09, 2024.
|
|
20094
|
-
``` curl
|
|
20095
|
-
|
|
20096
|
-
--header 'requestToken: <api-key>'
|
|
21028
|
+
``` curl -X GET https://sandbox.payabli.com/api/Query/transactions/org/1?limitRecord=20&fromRecord=0&transactionDate(ge)=2024-04-01T00:00:00&transactionDate(le)=2024-04-09T23:59:59\
|
|
21029
|
+
-H 'requestToken: <API TOKEN>'
|
|
20097
21030
|
|
|
20098
21031
|
```
|
|
20099
21032
|
</dd>
|
|
@@ -20297,9 +21230,8 @@ By default, this endpoint returns only transactions from the last 60 days. To qu
|
|
|
20297
21230
|
For example, this request parameters filter for transactions between April 01, 2024 and April 09, 2024.
|
|
20298
21231
|
|
|
20299
21232
|
```
|
|
20300
|
-
curl
|
|
20301
|
-
|
|
20302
|
-
--header 'requestToken: <api-key>'
|
|
21233
|
+
curl -X GET "https://sandbox.payabli.com/api/Query/transactions/org/1?limitRecord=20&fromRecord=0&transactionDate(ge)=2024-04-01T00:00:00&transactionDate(le)=2024-04-09T23:59:59"\
|
|
21234
|
+
-H 'requestToken: <API TOKEN>'
|
|
20303
21235
|
|
|
20304
21236
|
```
|
|
20305
21237
|
</dd>
|