payabli 3.0.11 → 3.0.13
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 +3 -3
- data/lib/payabli/client.rb +6 -1
- data/lib/payabli/device/client.rb +6 -5
- data/lib/payabli/money_out/client.rb +2 -2
- data/lib/payabli/payout_subscription/client.rb +4 -4
- data/lib/payabli/statistic/client.rb +16 -26
- data/lib/payabli/statistic/types/basic_stats_request.rb +0 -2
- data/lib/payabli/subscription/client.rb +2 -2
- data/lib/payabli/taptopay/client.rb +68 -0
- data/lib/payabli/taptopay/types/tap_to_pay_activation_challenge_request.rb +13 -0
- data/lib/payabli/types/owners.rb +1 -1
- data/lib/payabli/types/{stat_basic_query_record.rb → stat_customer_basic_query_record.rb} +1 -5
- data/lib/payabli/types/tap_to_pay_activation_challenge_data.rb +14 -0
- data/lib/payabli/types/tap_to_pay_activation_challenge_error_response.rb +16 -0
- data/lib/payabli/types/tap_to_pay_activation_challenge_error_response_response_data.rb +11 -0
- data/lib/payabli/types/tap_to_pay_activation_challenge_response.rb +22 -0
- data/lib/payabli/vendor/client.rb +3 -3
- data/lib/payabli/version.rb +1 -1
- data/lib/payabli.rb +7 -4
- data/reference.md +111 -55
- data/wiremock/wiremock-mappings.json +32 -6
- metadata +9 -6
- data/lib/payabli/statistic/types/customer_basic_stats_request.rb +0 -17
- data/lib/payabli/statistic/types/sub_stats_request.rb +0 -17
- data/lib/payabli/statistic/types/vendor_basic_stats_request.rb +0 -17
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 8946006d392b86821ddca421b6df062bc8eee4ec95a0dcb50047a3cb26028170
|
|
4
|
+
data.tar.gz: 72dcac1de9e3d8806338015dc194b71d53fb9cc6b1ddd65e0558d7477db3184c
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: affa80549a9b233312cbe15d2e76914808e828ed3d95af8f2855ab2525e58490e2ba04d8c348717abd8bc340d444d99584828173f38f20f36e70f65eefbc8049
|
|
7
|
+
data.tar.gz: 2c65f9330a1c0ba9f0799463ccc78b01028bb8435e8ba23595221fb991b11b914d172013c9d28204236aea52c06c419aa3250829fdb871165021d7b3204c42d8
|
data/.fern/metadata.json
CHANGED
|
@@ -7,10 +7,10 @@
|
|
|
7
7
|
"rubocopVariableNumberStyle": "snake_case",
|
|
8
8
|
"respectOptionalRequestBody": true
|
|
9
9
|
},
|
|
10
|
-
"originGitCommit": "
|
|
10
|
+
"originGitCommit": "92d377136ba191d0dbb9129cb9737063307d8c01",
|
|
11
11
|
"originGitCommitIsDirty": true,
|
|
12
12
|
"invokedBy": "ci",
|
|
13
|
-
"requestedVersion": "3.0.
|
|
13
|
+
"requestedVersion": "3.0.13",
|
|
14
14
|
"ciProvider": "github",
|
|
15
|
-
"sdkVersion": "3.0.
|
|
15
|
+
"sdkVersion": "3.0.13"
|
|
16
16
|
}
|
data/lib/payabli/client.rb
CHANGED
|
@@ -32,7 +32,7 @@ module Payabli
|
|
|
32
32
|
@raw_client = Payabli::Internal::Http::RawClient.new(
|
|
33
33
|
base_url: base_url || Payabli::Environment::SANDBOX,
|
|
34
34
|
headers: {
|
|
35
|
-
"User-Agent" => "payabli/3.0.
|
|
35
|
+
"User-Agent" => "payabli/3.0.13",
|
|
36
36
|
"X-Fern-Language" => "Ruby"
|
|
37
37
|
},
|
|
38
38
|
auth_provider: Payabli::Internal::RoutingAuthProvider.new(
|
|
@@ -128,6 +128,11 @@ module Payabli
|
|
|
128
128
|
@device ||= Payabli::Device::Client.new(client: @raw_client)
|
|
129
129
|
end
|
|
130
130
|
|
|
131
|
+
# @return [Payabli::Taptopay::Client]
|
|
132
|
+
def taptopay
|
|
133
|
+
@taptopay ||= Payabli::Taptopay::Client.new(client: @raw_client)
|
|
134
|
+
end
|
|
135
|
+
|
|
131
136
|
# @return [Payabli::Cloud::Client]
|
|
132
137
|
def cloud
|
|
133
138
|
@cloud ||= Payabli::Cloud::Client.new(client: @raw_client)
|
|
@@ -11,16 +11,17 @@ module Payabli
|
|
|
11
11
|
end
|
|
12
12
|
|
|
13
13
|
# Generates a one-time, 6-digit verification code for activating a
|
|
14
|
-
# semi-integrated card-present device in a paypoint.
|
|
15
|
-
#
|
|
16
|
-
# on the device's terminal, along with a
|
|
17
|
-
# device to the paypoint resolved from
|
|
14
|
+
# semi-integrated card-present device in a paypoint. This endpoint is
|
|
15
|
+
# for AXIUM devices only. After calling this endpoint, an operator
|
|
16
|
+
# enters the returned code on the device's terminal, along with a
|
|
17
|
+
# device name, to register the device to the paypoint resolved from
|
|
18
|
+
# `{entry}`.
|
|
18
19
|
#
|
|
19
20
|
# A code expires 5 minutes after it's issued. A paypoint can have several
|
|
20
21
|
# codes active at once — for example, when activating a batch of devices —
|
|
21
22
|
# and a code binds to whichever device enters it first.
|
|
22
23
|
#
|
|
23
|
-
# Authenticate with an OAuth2
|
|
24
|
+
# Authenticate with an OAuth2 bearer token that has the `device_registry` scope.
|
|
24
25
|
#
|
|
25
26
|
# @param request_options [Hash]
|
|
26
27
|
# @param params [Hash]
|
|
@@ -110,7 +110,7 @@ module Payabli
|
|
|
110
110
|
# @option request_options [Integer] :timeout_in_seconds
|
|
111
111
|
#
|
|
112
112
|
# @example
|
|
113
|
-
# client.money_out.cancel_all_out(request: %w[
|
|
113
|
+
# client.money_out.cancel_all_out(request: %w[129-230 129-219])
|
|
114
114
|
#
|
|
115
115
|
# @return [Payabli::Types::CaptureAllOutResponse]
|
|
116
116
|
def cancel_all_out(request_options: {}, **params)
|
|
@@ -230,7 +230,7 @@ module Payabli
|
|
|
230
230
|
# @option params [String, nil] :idempotency_key
|
|
231
231
|
#
|
|
232
232
|
# @example
|
|
233
|
-
# client.money_out.capture_all_out(body: %w[
|
|
233
|
+
# client.money_out.capture_all_out(body: %w[129-230 129-219])
|
|
234
234
|
#
|
|
235
235
|
# @return [Payabli::Types::CaptureAllOutResponse]
|
|
236
236
|
def capture_all_out(request_options: {}, **params)
|
|
@@ -43,12 +43,12 @@ module Payabli
|
|
|
43
43
|
# bill_data: [{
|
|
44
44
|
# invoice_number: "INV-2345",
|
|
45
45
|
# net_amount: "500",
|
|
46
|
-
# invoice_date: "
|
|
47
|
-
# due_date: "
|
|
46
|
+
# invoice_date: "2027-08-01",
|
|
47
|
+
# due_date: "2027-08-15"
|
|
48
48
|
# }],
|
|
49
49
|
# schedule_details: {
|
|
50
|
-
# start_date: "
|
|
51
|
-
# end_date: "
|
|
50
|
+
# start_date: "01/01/2027",
|
|
51
|
+
# end_date: "12/31/2027",
|
|
52
52
|
# frequency: "monthly"
|
|
53
53
|
# }
|
|
54
54
|
# )
|
|
@@ -10,8 +10,9 @@ module Payabli
|
|
|
10
10
|
@client = client
|
|
11
11
|
end
|
|
12
12
|
|
|
13
|
-
# Retrieves the basic statistics for an organization or a paypoint
|
|
14
|
-
#
|
|
13
|
+
# Retrieves the basic statistics for an organization or a paypoint over a date range, grouped by a frequency. The
|
|
14
|
+
# response returns one row per time bucket. Counts and volumes cover approved transactions only and leave out
|
|
15
|
+
# declines. Volumes are net of fees.
|
|
15
16
|
#
|
|
16
17
|
# @param request_options [Hash]
|
|
17
18
|
# @param params [Hash]
|
|
@@ -25,7 +26,6 @@ module Payabli
|
|
|
25
26
|
# @option params [Integer] :level
|
|
26
27
|
# @option params [Integer] :entry_id
|
|
27
28
|
# @option params [String, nil] :end_date
|
|
28
|
-
# @option params [Hash[String, String, nil], nil] :parameters
|
|
29
29
|
# @option params [String, nil] :start_date
|
|
30
30
|
#
|
|
31
31
|
# @example
|
|
@@ -43,7 +43,6 @@ module Payabli
|
|
|
43
43
|
params = Payabli::Internal::Types::Utils.normalize_keys(params)
|
|
44
44
|
query_params = {}
|
|
45
45
|
query_params["endDate"] = params[:end_date] if params.key?(:end_date)
|
|
46
|
-
query_params["parameters"] = params[:parameters] if params.key?(:parameters)
|
|
47
46
|
query_params["startDate"] = params[:start_date] if params.key?(:start_date)
|
|
48
47
|
|
|
49
48
|
headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
|
|
@@ -67,7 +66,9 @@ module Payabli
|
|
|
67
66
|
raise error_class.new(response.body, code: code)
|
|
68
67
|
end
|
|
69
68
|
|
|
70
|
-
# Retrieves the basic statistics for a customer
|
|
69
|
+
# Retrieves the basic statistics for a customer over a date range, grouped by a frequency. This is a Pay In view:
|
|
70
|
+
# it counts the customer's approved transactions and returns one row per time bucket. Volume here is the gross
|
|
71
|
+
# amount, before fees.
|
|
71
72
|
#
|
|
72
73
|
# @param request_options [Hash]
|
|
73
74
|
# @param params [Hash]
|
|
@@ -79,28 +80,23 @@ module Payabli
|
|
|
79
80
|
# @option params [String] :mode
|
|
80
81
|
# @option params [String] :freq
|
|
81
82
|
# @option params [Integer] :customer_id
|
|
82
|
-
# @option params [Hash[String, String, nil], nil] :parameters
|
|
83
83
|
#
|
|
84
84
|
# @example
|
|
85
85
|
# client.statistic.customer_basic_stats(
|
|
86
|
-
# mode: "
|
|
86
|
+
# mode: "m12",
|
|
87
87
|
# freq: "m",
|
|
88
88
|
# customer_id: 4440
|
|
89
89
|
# )
|
|
90
90
|
#
|
|
91
|
-
# @return [Array[Payabli::Types::
|
|
91
|
+
# @return [Array[Payabli::Types::StatCustomerBasicQueryRecord]]
|
|
92
92
|
def customer_basic_stats(request_options: {}, **params)
|
|
93
93
|
params = Payabli::Internal::Types::Utils.normalize_keys(params)
|
|
94
|
-
query_params = {}
|
|
95
|
-
query_params["parameters"] = params[:parameters] if params.key?(:parameters)
|
|
96
|
-
|
|
97
94
|
headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
|
|
98
95
|
request = Payabli::Internal::JSON::Request.new(
|
|
99
96
|
base_url: request_options[:base_url],
|
|
100
97
|
method: "GET",
|
|
101
98
|
path: "Statistic/customerbasic/#{URI.encode_uri_component(params[:mode].to_s)}/#{URI.encode_uri_component(params[:freq].to_s)}/#{URI.encode_uri_component(params[:customer_id].to_s)}",
|
|
102
99
|
headers: headers,
|
|
103
|
-
query: query_params,
|
|
104
100
|
request_options: request_options
|
|
105
101
|
)
|
|
106
102
|
begin
|
|
@@ -115,7 +111,9 @@ module Payabli
|
|
|
115
111
|
raise error_class.new(response.body, code: code)
|
|
116
112
|
end
|
|
117
113
|
|
|
118
|
-
# Retrieves
|
|
114
|
+
# Retrieves subscription statistics for a paypoint or organization, bucketed by how soon active subscriptions are
|
|
115
|
+
# due to renew. This is a forward-looking forecast of upcoming renewals, not charges already taken. Request a
|
|
116
|
+
# single window with `interval`, or `all` to return every window in one call.
|
|
119
117
|
#
|
|
120
118
|
# @param request_options [Hash]
|
|
121
119
|
# @param params [Hash]
|
|
@@ -127,28 +125,23 @@ module Payabli
|
|
|
127
125
|
# @option params [String] :interval
|
|
128
126
|
# @option params [Integer] :level
|
|
129
127
|
# @option params [Integer] :entry_id
|
|
130
|
-
# @option params [Hash[String, String, nil], nil] :parameters
|
|
131
128
|
#
|
|
132
129
|
# @example
|
|
133
130
|
# client.statistic.sub_stats(
|
|
134
|
-
# interval: "
|
|
131
|
+
# interval: "all",
|
|
135
132
|
# level: 2,
|
|
136
133
|
# entry_id: 1000000
|
|
137
134
|
# )
|
|
138
135
|
#
|
|
139
|
-
# @return [Array[Payabli::Types::
|
|
136
|
+
# @return [Array[Payabli::Types::SubscriptionStatsQueryRecord]]
|
|
140
137
|
def sub_stats(request_options: {}, **params)
|
|
141
138
|
params = Payabli::Internal::Types::Utils.normalize_keys(params)
|
|
142
|
-
query_params = {}
|
|
143
|
-
query_params["parameters"] = params[:parameters] if params.key?(:parameters)
|
|
144
|
-
|
|
145
139
|
headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
|
|
146
140
|
request = Payabli::Internal::JSON::Request.new(
|
|
147
141
|
base_url: request_options[:base_url],
|
|
148
142
|
method: "GET",
|
|
149
143
|
path: "Statistic/subscriptions/#{URI.encode_uri_component(params[:interval].to_s)}/#{URI.encode_uri_component(params[:level].to_s)}/#{URI.encode_uri_component(params[:entry_id].to_s)}",
|
|
150
144
|
headers: headers,
|
|
151
|
-
query: query_params,
|
|
152
145
|
request_options: request_options
|
|
153
146
|
)
|
|
154
147
|
begin
|
|
@@ -163,7 +156,9 @@ module Payabli
|
|
|
163
156
|
raise error_class.new(response.body, code: code)
|
|
164
157
|
end
|
|
165
158
|
|
|
166
|
-
# Retrieve the basic statistics about a vendor
|
|
159
|
+
# Retrieve the basic statistics about a vendor over a date range, grouped by frequency. The response returns one
|
|
160
|
+
# row per time bucket, breaking the vendor's bills down by bill state (active, sent to approval, approved, in
|
|
161
|
+
# transit, paid, and so on). Volumes are net of fees.
|
|
167
162
|
#
|
|
168
163
|
# @param request_options [Hash]
|
|
169
164
|
# @param params [Hash]
|
|
@@ -175,7 +170,6 @@ module Payabli
|
|
|
175
170
|
# @option params [String] :mode
|
|
176
171
|
# @option params [String] :freq
|
|
177
172
|
# @option params [Integer] :id_vendor
|
|
178
|
-
# @option params [Hash[String, String, nil], nil] :parameters
|
|
179
173
|
#
|
|
180
174
|
# @example
|
|
181
175
|
# client.statistic.vendor_basic_stats(
|
|
@@ -187,16 +181,12 @@ module Payabli
|
|
|
187
181
|
# @return [Array[Payabli::Types::StatisticsVendorQueryRecord]]
|
|
188
182
|
def vendor_basic_stats(request_options: {}, **params)
|
|
189
183
|
params = Payabli::Internal::Types::Utils.normalize_keys(params)
|
|
190
|
-
query_params = {}
|
|
191
|
-
query_params["parameters"] = params[:parameters] if params.key?(:parameters)
|
|
192
|
-
|
|
193
184
|
headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }, { "APIKeyAuth" => [] }])
|
|
194
185
|
request = Payabli::Internal::JSON::Request.new(
|
|
195
186
|
base_url: request_options[:base_url],
|
|
196
187
|
method: "GET",
|
|
197
188
|
path: "Statistic/vendorbasic/#{URI.encode_uri_component(params[:mode].to_s)}/#{URI.encode_uri_component(params[:freq].to_s)}/#{URI.encode_uri_component(params[:id_vendor].to_s)}",
|
|
198
189
|
headers: headers,
|
|
199
|
-
query: query_params,
|
|
200
190
|
request_options: request_options
|
|
201
191
|
)
|
|
202
192
|
begin
|
|
@@ -14,8 +14,6 @@ module Payabli
|
|
|
14
14
|
|
|
15
15
|
field :end_date, -> { String }, optional: true, nullable: false, api_name: "endDate"
|
|
16
16
|
|
|
17
|
-
field :parameters, -> { Internal::Types::Hash[String, String] }, optional: true, nullable: false
|
|
18
|
-
|
|
19
17
|
field :start_date, -> { String }, optional: true, nullable: false, api_name: "startDate"
|
|
20
18
|
end
|
|
21
19
|
end
|
|
@@ -168,10 +168,10 @@ module Payabli
|
|
|
168
168
|
# method_: "card"
|
|
169
169
|
# },
|
|
170
170
|
# schedule_details: {
|
|
171
|
-
# end_date: "
|
|
171
|
+
# end_date: "2027-12-31",
|
|
172
172
|
# frequency: "weekly",
|
|
173
173
|
# plan_id: 1,
|
|
174
|
-
# start_date: "
|
|
174
|
+
# start_date: "2027-01-01"
|
|
175
175
|
# }
|
|
176
176
|
# )
|
|
177
177
|
#
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Payabli
|
|
4
|
+
module Taptopay
|
|
5
|
+
class Client
|
|
6
|
+
# @param client [Payabli::Internal::Http::RawClient]
|
|
7
|
+
#
|
|
8
|
+
# @return [void]
|
|
9
|
+
def initialize(client:)
|
|
10
|
+
@client = client
|
|
11
|
+
end
|
|
12
|
+
|
|
13
|
+
# Issues a short-lived activation code for a Tap to Pay device in the
|
|
14
|
+
# `Pending` state. This endpoint is for Tap to Pay devices only.
|
|
15
|
+
# Deliver the code to the device to complete activation.
|
|
16
|
+
#
|
|
17
|
+
# A code is valid for 30 minutes after it's issued. Calling this
|
|
18
|
+
# endpoint again for the same device before the code expires returns
|
|
19
|
+
# the same code, with `alreadyIssued` set to `true`, instead of
|
|
20
|
+
# generating a new one. A new code is only generated when no valid
|
|
21
|
+
# code exists.
|
|
22
|
+
#
|
|
23
|
+
# Authenticate with an OAuth2 bearer token that has the `pos_create`
|
|
24
|
+
# permission. See [Accept Tap to Pay payments](/guides/pay-in-developer-tap-to-pay)
|
|
25
|
+
# for the full integration guide.
|
|
26
|
+
#
|
|
27
|
+
# @param request_options [Hash]
|
|
28
|
+
# @param params [Payabli::Taptopay::Types::TapToPayActivationChallengeRequest]
|
|
29
|
+
# @option request_options [String] :base_url
|
|
30
|
+
# @option request_options [Hash{String => Object}] :additional_headers
|
|
31
|
+
# @option request_options [Hash{String => Object}] :additional_query_parameters
|
|
32
|
+
# @option request_options [Hash{String => Object}] :additional_body_parameters
|
|
33
|
+
# @option request_options [Integer] :timeout_in_seconds
|
|
34
|
+
#
|
|
35
|
+
# @example
|
|
36
|
+
# client.taptopay.activation_challenge(
|
|
37
|
+
# entry: "8cfec329267",
|
|
38
|
+
# device_id: "499585-389fj484-3jcj8hj3"
|
|
39
|
+
# )
|
|
40
|
+
#
|
|
41
|
+
# @return [Payabli::Types::TapToPayActivationChallengeResponse]
|
|
42
|
+
def activation_challenge(request_options: {}, **params)
|
|
43
|
+
params = Payabli::Internal::Types::Utils.normalize_keys(params)
|
|
44
|
+
headers = @client.auth_headers_for_endpoint(security: [{ "BearerAuth" => [] }])
|
|
45
|
+
request = Payabli::Internal::JSON::Request.new(
|
|
46
|
+
base_url: request_options[:base_url],
|
|
47
|
+
method: "POST",
|
|
48
|
+
path: "v2/device/taptopay/activate/challenge",
|
|
49
|
+
headers: headers,
|
|
50
|
+
body: Payabli::Taptopay::Types::TapToPayActivationChallengeRequest.new(params).to_h,
|
|
51
|
+
request_options: request_options
|
|
52
|
+
)
|
|
53
|
+
begin
|
|
54
|
+
response = @client.send(request)
|
|
55
|
+
rescue Net::HTTPRequestTimeout
|
|
56
|
+
raise Payabli::Errors::TimeoutError
|
|
57
|
+
end
|
|
58
|
+
code = response.code.to_i
|
|
59
|
+
if code.between?(200, 299)
|
|
60
|
+
Payabli::Types::TapToPayActivationChallengeResponse.load(response.body)
|
|
61
|
+
else
|
|
62
|
+
error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
|
|
63
|
+
raise error_class.new(response.body, code: code)
|
|
64
|
+
end
|
|
65
|
+
end
|
|
66
|
+
end
|
|
67
|
+
end
|
|
68
|
+
end
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Payabli
|
|
4
|
+
module Taptopay
|
|
5
|
+
module Types
|
|
6
|
+
class TapToPayActivationChallengeRequest < Internal::Types::Model
|
|
7
|
+
field :entry, -> { String }, optional: false, nullable: false
|
|
8
|
+
|
|
9
|
+
field :device_id, -> { String }, optional: false, nullable: false, api_name: "deviceId"
|
|
10
|
+
end
|
|
11
|
+
end
|
|
12
|
+
end
|
|
13
|
+
end
|
data/lib/payabli/types/owners.rb
CHANGED
|
@@ -33,7 +33,7 @@ module Payabli
|
|
|
33
33
|
|
|
34
34
|
field :ozip, -> { String }, optional: true, nullable: false
|
|
35
35
|
|
|
36
|
-
field :additional_data, -> { String }, optional: true, nullable: false, api_name: "additionalData"
|
|
36
|
+
field :additional_data, -> { Internal::Types::Hash[String, String] }, optional: true, nullable: false, api_name: "additionalData"
|
|
37
37
|
end
|
|
38
38
|
end
|
|
39
39
|
end
|
|
@@ -2,16 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
module Payabli
|
|
4
4
|
module Types
|
|
5
|
-
class
|
|
5
|
+
class StatCustomerBasicQueryRecord < Internal::Types::Model
|
|
6
6
|
field :stat_x, -> { String }, optional: false, nullable: false, api_name: "statX"
|
|
7
7
|
|
|
8
8
|
field :in_transactions, -> { Integer }, optional: false, nullable: false, api_name: "inTransactions"
|
|
9
9
|
|
|
10
10
|
field :in_transactions_volume, -> { Integer }, optional: false, nullable: false, api_name: "inTransactionsVolume"
|
|
11
|
-
|
|
12
|
-
field :in_wallet_transactions, -> { Integer }, optional: false, nullable: false, api_name: "inWalletTransactions"
|
|
13
|
-
|
|
14
|
-
field :in_wallet_volume, -> { Integer }, optional: false, nullable: false, api_name: "inWalletVolume"
|
|
15
11
|
end
|
|
16
12
|
end
|
|
17
13
|
end
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Payabli
|
|
4
|
+
module Types
|
|
5
|
+
# The issued activation code, its expiration, and whether it was reused.
|
|
6
|
+
class TapToPayActivationChallengeData < Internal::Types::Model
|
|
7
|
+
field :code, -> { String }, optional: false, nullable: false
|
|
8
|
+
|
|
9
|
+
field :expires_at, -> { String }, optional: false, nullable: false, api_name: "expiresAt"
|
|
10
|
+
|
|
11
|
+
field :already_issued, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "alreadyIssued"
|
|
12
|
+
end
|
|
13
|
+
end
|
|
14
|
+
end
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Payabli
|
|
4
|
+
module Types
|
|
5
|
+
# Error response for a Tap to Pay activation challenge request.
|
|
6
|
+
# `responseData` carries the same status code as the HTTP response
|
|
7
|
+
# and a message describing the refusal.
|
|
8
|
+
class TapToPayActivationChallengeErrorResponse < Internal::Types::Model
|
|
9
|
+
field :is_success, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "isSuccess"
|
|
10
|
+
|
|
11
|
+
field :response_text, -> { String }, optional: false, nullable: false, api_name: "responseText"
|
|
12
|
+
|
|
13
|
+
field :response_data, -> { Payabli::Types::TapToPayActivationChallengeErrorResponseResponseData }, optional: false, nullable: false, api_name: "responseData"
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Payabli
|
|
4
|
+
module Types
|
|
5
|
+
class TapToPayActivationChallengeErrorResponseResponseData < Internal::Types::Model
|
|
6
|
+
field :result_code, -> { Integer }, optional: false, nullable: false, api_name: "resultCode"
|
|
7
|
+
|
|
8
|
+
field :result_text, -> { String }, optional: false, nullable: false, api_name: "resultText"
|
|
9
|
+
end
|
|
10
|
+
end
|
|
11
|
+
end
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Payabli
|
|
4
|
+
module Types
|
|
5
|
+
# Response to a Tap to Pay activation code request. On success,
|
|
6
|
+
# `responseData` carries the activation code, its expiration, and
|
|
7
|
+
# whether an existing code was reused.
|
|
8
|
+
class TapToPayActivationChallengeResponse < Internal::Types::Model
|
|
9
|
+
field :response_code, -> { Integer }, optional: true, nullable: false, api_name: "responseCode"
|
|
10
|
+
|
|
11
|
+
field :page_identifier, -> { String }, optional: true, nullable: false, api_name: "pageIdentifier"
|
|
12
|
+
|
|
13
|
+
field :room_id, -> { Integer }, optional: true, nullable: false, api_name: "roomId"
|
|
14
|
+
|
|
15
|
+
field :is_success, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isSuccess"
|
|
16
|
+
|
|
17
|
+
field :response_text, -> { String }, optional: false, nullable: false, api_name: "responseText"
|
|
18
|
+
|
|
19
|
+
field :response_data, -> { Payabli::Types::TapToPayActivationChallengeData }, optional: false, nullable: false, api_name: "responseData"
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -52,9 +52,9 @@ module Payabli
|
|
|
52
52
|
# location_code: "MIA123",
|
|
53
53
|
# mcc: "7777",
|
|
54
54
|
# name_1: "Herman's Coatings and Masonry",
|
|
55
|
-
# name_2: "
|
|
56
|
-
# payee_name_1: "
|
|
57
|
-
# payee_name_2: "
|
|
55
|
+
# name_2: "HCM Services",
|
|
56
|
+
# payee_name_1: "Herman Martinez",
|
|
57
|
+
# payee_name_2: "Herman Coatings",
|
|
58
58
|
# payment_method: "managed",
|
|
59
59
|
# phone: "5555555555",
|
|
60
60
|
# remit_address_1: "123 Walnut Street",
|
data/lib/payabli/version.rb
CHANGED
data/lib/payabli.rb
CHANGED
|
@@ -659,6 +659,10 @@ require_relative "payabli/types/notification_log_detail"
|
|
|
659
659
|
require_relative "payabli/types/bulk_retry_request"
|
|
660
660
|
require_relative "payabli/types/device_challenge_data"
|
|
661
661
|
require_relative "payabli/types/device_challenge_response"
|
|
662
|
+
require_relative "payabli/types/tap_to_pay_activation_challenge_data"
|
|
663
|
+
require_relative "payabli/types/tap_to_pay_activation_challenge_response"
|
|
664
|
+
require_relative "payabli/types/tap_to_pay_activation_challenge_error_response_response_data"
|
|
665
|
+
require_relative "payabli/types/tap_to_pay_activation_challenge_error_response"
|
|
662
666
|
require_relative "payabli/types/add_device_response"
|
|
663
667
|
require_relative "payabli/types/remove_device_response"
|
|
664
668
|
require_relative "payabli/types/poi_device"
|
|
@@ -812,8 +816,8 @@ require_relative "payabli/types/delete_organization_response"
|
|
|
812
816
|
require_relative "payabli/types/bank_account_verification_details_response"
|
|
813
817
|
require_relative "payabli/types/verify_account_details_response"
|
|
814
818
|
require_relative "payabli/types/stat_basic_extended_query_record"
|
|
819
|
+
require_relative "payabli/types/stat_customer_basic_query_record"
|
|
815
820
|
require_relative "payabli/types/subscription_stats_query_record"
|
|
816
|
-
require_relative "payabli/types/stat_basic_query_record"
|
|
817
821
|
require_relative "payabli/types/statistics_vendor_query_record"
|
|
818
822
|
require_relative "payabli/types/notification_standard_request_content_event_type"
|
|
819
823
|
require_relative "payabli/types/notification_standard_request_content"
|
|
@@ -1081,6 +1085,8 @@ require_relative "payabli/ocr/types/ocr_document_json_request"
|
|
|
1081
1085
|
require_relative "payabli/notificationlogs/client"
|
|
1082
1086
|
require_relative "payabli/notificationlogs/types/search_notification_logs_request"
|
|
1083
1087
|
require_relative "payabli/device/client"
|
|
1088
|
+
require_relative "payabli/taptopay/client"
|
|
1089
|
+
require_relative "payabli/taptopay/types/tap_to_pay_activation_challenge_request"
|
|
1084
1090
|
require_relative "payabli/cloud/client"
|
|
1085
1091
|
require_relative "payabli/cloud/types/device_entry"
|
|
1086
1092
|
require_relative "payabli/cloud/types/list_device_request"
|
|
@@ -1132,9 +1138,6 @@ require_relative "payabli/management/client"
|
|
|
1132
1138
|
require_relative "payabli/management/types/verify_account_details_request"
|
|
1133
1139
|
require_relative "payabli/statistic/client"
|
|
1134
1140
|
require_relative "payabli/statistic/types/basic_stats_request"
|
|
1135
|
-
require_relative "payabli/statistic/types/customer_basic_stats_request"
|
|
1136
|
-
require_relative "payabli/statistic/types/sub_stats_request"
|
|
1137
|
-
require_relative "payabli/statistic/types/vendor_basic_stats_request"
|
|
1138
1141
|
require_relative "payabli/notification/client"
|
|
1139
1142
|
require_relative "payabli/user/client"
|
|
1140
1143
|
require_relative "payabli/user/types/get_user_request"
|
data/reference.md
CHANGED
|
@@ -3663,10 +3663,10 @@ client.subscription.new_subscription(
|
|
|
3663
3663
|
method_: "card"
|
|
3664
3664
|
},
|
|
3665
3665
|
schedule_details: {
|
|
3666
|
-
end_date: "
|
|
3666
|
+
end_date: "2027-12-31",
|
|
3667
3667
|
frequency: "weekly",
|
|
3668
3668
|
plan_id: 1,
|
|
3669
|
-
start_date: "
|
|
3669
|
+
start_date: "2027-01-01"
|
|
3670
3670
|
}
|
|
3671
3671
|
)
|
|
3672
3672
|
```
|
|
@@ -15340,15 +15340,17 @@ client.notificationlogs.bulk_retry_notification_logs(request: %w[550e8400-e29b-4
|
|
|
15340
15340
|
<dd>
|
|
15341
15341
|
|
|
15342
15342
|
Generates a one-time, 6-digit verification code for activating a
|
|
15343
|
-
semi-integrated card-present device in a paypoint.
|
|
15344
|
-
|
|
15345
|
-
|
|
15343
|
+
semi-integrated card-present device in a paypoint. This endpoint is
|
|
15344
|
+
for AXIUM devices only. After calling this endpoint, an operator
|
|
15345
|
+
enters the returned code on the device's terminal, along with a
|
|
15346
|
+
device name, to register the device to the paypoint resolved from
|
|
15347
|
+
`{entry}`.
|
|
15346
15348
|
|
|
15347
15349
|
A code expires 5 minutes after it's issued. A paypoint can have several
|
|
15348
15350
|
codes active at once — for example, when activating a batch of devices —
|
|
15349
15351
|
and a code binds to whichever device enters it first.
|
|
15350
15352
|
|
|
15351
|
-
Authenticate with an OAuth2
|
|
15353
|
+
Authenticate with an OAuth2 bearer token that has the `device_registry` scope.
|
|
15352
15354
|
</dd>
|
|
15353
15355
|
</dl>
|
|
15354
15356
|
</dd>
|
|
@@ -15394,6 +15396,92 @@ client.device.challenge(entry: "8cfec329267")
|
|
|
15394
15396
|
</dl>
|
|
15395
15397
|
|
|
15396
15398
|
|
|
15399
|
+
</dd>
|
|
15400
|
+
</dl>
|
|
15401
|
+
</details>
|
|
15402
|
+
|
|
15403
|
+
## TapToPay
|
|
15404
|
+
<details><summary><code>client.taptopay.<a href="/lib/payabli/taptopay/client.rb">activation_challenge</a>(request) -> Payabli::Types::TapToPayActivationChallengeResponse</code></summary>
|
|
15405
|
+
<dl>
|
|
15406
|
+
<dd>
|
|
15407
|
+
|
|
15408
|
+
#### 📝 Description
|
|
15409
|
+
|
|
15410
|
+
<dl>
|
|
15411
|
+
<dd>
|
|
15412
|
+
|
|
15413
|
+
<dl>
|
|
15414
|
+
<dd>
|
|
15415
|
+
|
|
15416
|
+
Issues a short-lived activation code for a Tap to Pay device in the
|
|
15417
|
+
`Pending` state. This endpoint is for Tap to Pay devices only.
|
|
15418
|
+
Deliver the code to the device to complete activation.
|
|
15419
|
+
|
|
15420
|
+
A code is valid for 30 minutes after it's issued. Calling this
|
|
15421
|
+
endpoint again for the same device before the code expires returns
|
|
15422
|
+
the same code, with `alreadyIssued` set to `true`, instead of
|
|
15423
|
+
generating a new one. A new code is only generated when no valid
|
|
15424
|
+
code exists.
|
|
15425
|
+
|
|
15426
|
+
Authenticate with an OAuth2 bearer token that has the `pos_create`
|
|
15427
|
+
permission. See [Accept Tap to Pay payments](/guides/pay-in-developer-tap-to-pay)
|
|
15428
|
+
for the full integration guide.
|
|
15429
|
+
</dd>
|
|
15430
|
+
</dl>
|
|
15431
|
+
</dd>
|
|
15432
|
+
</dl>
|
|
15433
|
+
|
|
15434
|
+
#### 🔌 Usage
|
|
15435
|
+
|
|
15436
|
+
<dl>
|
|
15437
|
+
<dd>
|
|
15438
|
+
|
|
15439
|
+
<dl>
|
|
15440
|
+
<dd>
|
|
15441
|
+
|
|
15442
|
+
```ruby
|
|
15443
|
+
client.taptopay.activation_challenge(
|
|
15444
|
+
entry: "8cfec329267",
|
|
15445
|
+
device_id: "499585-389fj484-3jcj8hj3"
|
|
15446
|
+
)
|
|
15447
|
+
```
|
|
15448
|
+
</dd>
|
|
15449
|
+
</dl>
|
|
15450
|
+
</dd>
|
|
15451
|
+
</dl>
|
|
15452
|
+
|
|
15453
|
+
#### ⚙️ Parameters
|
|
15454
|
+
|
|
15455
|
+
<dl>
|
|
15456
|
+
<dd>
|
|
15457
|
+
|
|
15458
|
+
<dl>
|
|
15459
|
+
<dd>
|
|
15460
|
+
|
|
15461
|
+
**entry:** `String`
|
|
15462
|
+
|
|
15463
|
+
</dd>
|
|
15464
|
+
</dl>
|
|
15465
|
+
|
|
15466
|
+
<dl>
|
|
15467
|
+
<dd>
|
|
15468
|
+
|
|
15469
|
+
**device_id:** `String` — The device identifier (`poiId`) returned when the device was registered.
|
|
15470
|
+
|
|
15471
|
+
</dd>
|
|
15472
|
+
</dl>
|
|
15473
|
+
|
|
15474
|
+
<dl>
|
|
15475
|
+
<dd>
|
|
15476
|
+
|
|
15477
|
+
**request_options:** `Payabli::Taptopay::RequestOptions`
|
|
15478
|
+
|
|
15479
|
+
</dd>
|
|
15480
|
+
</dl>
|
|
15481
|
+
</dd>
|
|
15482
|
+
</dl>
|
|
15483
|
+
|
|
15484
|
+
|
|
15397
15485
|
</dd>
|
|
15398
15486
|
</dl>
|
|
15399
15487
|
</details>
|
|
@@ -23532,7 +23620,7 @@ client.management.verify_account_details(
|
|
|
23532
23620
|
<dl>
|
|
23533
23621
|
<dd>
|
|
23534
23622
|
|
|
23535
|
-
Retrieves the basic statistics for an organization or a paypoint
|
|
23623
|
+
Retrieves the basic statistics for an organization or a paypoint over a date range, grouped by a frequency. The response returns one row per time bucket. Counts and volumes cover approved transactions only and leave out declines. Volumes are net of fees.
|
|
23536
23624
|
</dd>
|
|
23537
23625
|
</dl>
|
|
23538
23626
|
</dd>
|
|
@@ -23644,14 +23732,6 @@ Valid formats:
|
|
|
23644
23732
|
<dl>
|
|
23645
23733
|
<dd>
|
|
23646
23734
|
|
|
23647
|
-
**parameters:** `Internal::Types::Hash[String, String]` — List of parameters.
|
|
23648
|
-
|
|
23649
|
-
</dd>
|
|
23650
|
-
</dl>
|
|
23651
|
-
|
|
23652
|
-
<dl>
|
|
23653
|
-
<dd>
|
|
23654
|
-
|
|
23655
23735
|
**start_date:** `String`
|
|
23656
23736
|
|
|
23657
23737
|
Used with `custom` mode. The start date for the range.
|
|
@@ -23679,7 +23759,7 @@ Valid formats:
|
|
|
23679
23759
|
</dl>
|
|
23680
23760
|
</details>
|
|
23681
23761
|
|
|
23682
|
-
<details><summary><code>client.statistic.<a href="/lib/payabli/statistic/client.rb">customer_basic_stats</a>(mode:, freq:, customer_id:) -> Internal::Types::Array[Payabli::Types::
|
|
23762
|
+
<details><summary><code>client.statistic.<a href="/lib/payabli/statistic/client.rb">customer_basic_stats</a>(mode:, freq:, customer_id:) -> Internal::Types::Array[Payabli::Types::StatCustomerBasicQueryRecord]</code></summary>
|
|
23683
23763
|
<dl>
|
|
23684
23764
|
<dd>
|
|
23685
23765
|
|
|
@@ -23691,7 +23771,7 @@ Valid formats:
|
|
|
23691
23771
|
<dl>
|
|
23692
23772
|
<dd>
|
|
23693
23773
|
|
|
23694
|
-
Retrieves the basic statistics for a customer
|
|
23774
|
+
Retrieves the basic statistics for a customer over a date range, grouped by a frequency. This is a Pay In view: it counts the customer's approved transactions and returns one row per time bucket. Volume here is the gross amount, before fees.
|
|
23695
23775
|
</dd>
|
|
23696
23776
|
</dl>
|
|
23697
23777
|
</dd>
|
|
@@ -23707,7 +23787,7 @@ Retrieves the basic statistics for a customer for a specific time period, groupe
|
|
|
23707
23787
|
|
|
23708
23788
|
```ruby
|
|
23709
23789
|
client.statistic.customer_basic_stats(
|
|
23710
|
-
mode: "
|
|
23790
|
+
mode: "m12",
|
|
23711
23791
|
freq: "m",
|
|
23712
23792
|
customer_id: 4440
|
|
23713
23793
|
)
|
|
@@ -23772,14 +23852,6 @@ For example, `w` groups the results by week.
|
|
|
23772
23852
|
<dl>
|
|
23773
23853
|
<dd>
|
|
23774
23854
|
|
|
23775
|
-
**parameters:** `Internal::Types::Hash[String, String]` — List of parameters.
|
|
23776
|
-
|
|
23777
|
-
</dd>
|
|
23778
|
-
</dl>
|
|
23779
|
-
|
|
23780
|
-
<dl>
|
|
23781
|
-
<dd>
|
|
23782
|
-
|
|
23783
23855
|
**request_options:** `Payabli::Statistic::RequestOptions`
|
|
23784
23856
|
|
|
23785
23857
|
</dd>
|
|
@@ -23792,7 +23864,7 @@ For example, `w` groups the results by week.
|
|
|
23792
23864
|
</dl>
|
|
23793
23865
|
</details>
|
|
23794
23866
|
|
|
23795
|
-
<details><summary><code>client.statistic.<a href="/lib/payabli/statistic/client.rb">sub_stats</a>(interval:, level:, entry_id:) -> Internal::Types::Array[Payabli::Types::
|
|
23867
|
+
<details><summary><code>client.statistic.<a href="/lib/payabli/statistic/client.rb">sub_stats</a>(interval:, level:, entry_id:) -> Internal::Types::Array[Payabli::Types::SubscriptionStatsQueryRecord]</code></summary>
|
|
23796
23868
|
<dl>
|
|
23797
23869
|
<dd>
|
|
23798
23870
|
|
|
@@ -23804,7 +23876,7 @@ For example, `w` groups the results by week.
|
|
|
23804
23876
|
<dl>
|
|
23805
23877
|
<dd>
|
|
23806
23878
|
|
|
23807
|
-
Retrieves
|
|
23879
|
+
Retrieves subscription statistics for a paypoint or organization, bucketed by how soon active subscriptions are due to renew. This is a forward-looking forecast of upcoming renewals, not charges already taken. Request a single window with `interval`, or `all` to return every window in one call.
|
|
23808
23880
|
</dd>
|
|
23809
23881
|
</dl>
|
|
23810
23882
|
</dd>
|
|
@@ -23820,7 +23892,7 @@ Retrieves the subscription statistics for a given interval for a paypoint or org
|
|
|
23820
23892
|
|
|
23821
23893
|
```ruby
|
|
23822
23894
|
client.statistic.sub_stats(
|
|
23823
|
-
interval: "
|
|
23895
|
+
interval: "all",
|
|
23824
23896
|
level: 2,
|
|
23825
23897
|
entry_id: 1000000
|
|
23826
23898
|
)
|
|
@@ -23874,14 +23946,6 @@ The entry level for the request:
|
|
|
23874
23946
|
<dl>
|
|
23875
23947
|
<dd>
|
|
23876
23948
|
|
|
23877
|
-
**parameters:** `Internal::Types::Hash[String, String]` — List of parameters
|
|
23878
|
-
|
|
23879
|
-
</dd>
|
|
23880
|
-
</dl>
|
|
23881
|
-
|
|
23882
|
-
<dl>
|
|
23883
|
-
<dd>
|
|
23884
|
-
|
|
23885
23949
|
**request_options:** `Payabli::Statistic::RequestOptions`
|
|
23886
23950
|
|
|
23887
23951
|
</dd>
|
|
@@ -23906,7 +23970,7 @@ The entry level for the request:
|
|
|
23906
23970
|
<dl>
|
|
23907
23971
|
<dd>
|
|
23908
23972
|
|
|
23909
|
-
Retrieve the basic statistics about a vendor
|
|
23973
|
+
Retrieve the basic statistics about a vendor over a date range, grouped by frequency. The response returns one row per time bucket, breaking the vendor's bills down by bill state (active, sent to approval, approved, in transit, paid, and so on). Volumes are net of fees.
|
|
23910
23974
|
</dd>
|
|
23911
23975
|
</dl>
|
|
23912
23976
|
</dd>
|
|
@@ -23987,14 +24051,6 @@ For example, `w` groups the results by week.
|
|
|
23987
24051
|
<dl>
|
|
23988
24052
|
<dd>
|
|
23989
24053
|
|
|
23990
|
-
**parameters:** `Internal::Types::Hash[String, String]` — List of parameters
|
|
23991
|
-
|
|
23992
|
-
</dd>
|
|
23993
|
-
</dl>
|
|
23994
|
-
|
|
23995
|
-
<dl>
|
|
23996
|
-
<dd>
|
|
23997
|
-
|
|
23998
24054
|
**request_options:** `Payabli::Statistic::RequestOptions`
|
|
23999
24055
|
|
|
24000
24056
|
</dd>
|
|
@@ -25261,9 +25317,9 @@ client.vendor.add_vendor(
|
|
|
25261
25317
|
location_code: "MIA123",
|
|
25262
25318
|
mcc: "7777",
|
|
25263
25319
|
name_1: "Herman's Coatings and Masonry",
|
|
25264
|
-
name_2: "
|
|
25265
|
-
payee_name_1: "
|
|
25266
|
-
payee_name_2: "
|
|
25320
|
+
name_2: "HCM Services",
|
|
25321
|
+
payee_name_1: "Herman Martinez",
|
|
25322
|
+
payee_name_2: "Herman Coatings",
|
|
25267
25323
|
payment_method: "managed",
|
|
25268
25324
|
phone: "5555555555",
|
|
25269
25325
|
remit_address_1: "123 Walnut Street",
|
|
@@ -26286,7 +26342,7 @@ Cancels an array of payout transactions.
|
|
|
26286
26342
|
<dd>
|
|
26287
26343
|
|
|
26288
26344
|
```ruby
|
|
26289
|
-
client.money_out.cancel_all_out(request: %w[
|
|
26345
|
+
client.money_out.cancel_all_out(request: %w[129-230 129-219])
|
|
26290
26346
|
```
|
|
26291
26347
|
</dd>
|
|
26292
26348
|
</dl>
|
|
@@ -26472,7 +26528,7 @@ Captures an array of authorized payout transactions for settlement. The maximum
|
|
|
26472
26528
|
<dd>
|
|
26473
26529
|
|
|
26474
26530
|
```ruby
|
|
26475
|
-
client.money_out.capture_all_out(body: %w[
|
|
26531
|
+
client.money_out.capture_all_out(body: %w[129-230 129-219])
|
|
26476
26532
|
```
|
|
26477
26533
|
</dd>
|
|
26478
26534
|
</dl>
|
|
@@ -27722,12 +27778,12 @@ client.payout_subscription.create_payout_subscription(
|
|
|
27722
27778
|
bill_data: [{
|
|
27723
27779
|
invoice_number: "INV-2345",
|
|
27724
27780
|
net_amount: "500",
|
|
27725
|
-
invoice_date: "
|
|
27726
|
-
due_date: "
|
|
27781
|
+
invoice_date: "2027-08-01",
|
|
27782
|
+
due_date: "2027-08-15"
|
|
27727
27783
|
}],
|
|
27728
27784
|
schedule_details: {
|
|
27729
|
-
start_date: "
|
|
27730
|
-
end_date: "
|
|
27785
|
+
start_date: "01/01/2027",
|
|
27786
|
+
end_date: "12/31/2027",
|
|
27731
27787
|
frequency: "monthly"
|
|
27732
27788
|
}
|
|
27733
27789
|
)
|
|
@@ -4800,6 +4800,32 @@
|
|
|
4800
4800
|
}
|
|
4801
4801
|
}
|
|
4802
4802
|
},
|
|
4803
|
+
{
|
|
4804
|
+
"id": "18b69a4d-2e73-4044-a7a5-e3edd36799c3",
|
|
4805
|
+
"name": "Generate Tap to Pay activation code - Generate Tap to Pay activation code",
|
|
4806
|
+
"request": {
|
|
4807
|
+
"urlPathTemplate": "/v2/device/taptopay/activate/challenge",
|
|
4808
|
+
"method": "POST"
|
|
4809
|
+
},
|
|
4810
|
+
"response": {
|
|
4811
|
+
"status": 200,
|
|
4812
|
+
"body": "{\n \"isSuccess\": true,\n \"responseText\": \"Success\",\n \"responseData\": {\n \"code\": \"748801\",\n \"expiresAt\": \"2026-09-10T20:28:27.5860203Z\",\n \"alreadyIssued\": false\n }\n}",
|
|
4813
|
+
"headers": {
|
|
4814
|
+
"Content-Type": "application/json"
|
|
4815
|
+
}
|
|
4816
|
+
},
|
|
4817
|
+
"uuid": "18b69a4d-2e73-4044-a7a5-e3edd36799c3",
|
|
4818
|
+
"persistent": true,
|
|
4819
|
+
"priority": 3,
|
|
4820
|
+
"metadata": {
|
|
4821
|
+
"mocklab": {
|
|
4822
|
+
"created": {
|
|
4823
|
+
"at": "2020-01-01T00:00:00.000Z",
|
|
4824
|
+
"via": "SYSTEM"
|
|
4825
|
+
}
|
|
4826
|
+
}
|
|
4827
|
+
}
|
|
4828
|
+
},
|
|
4803
4829
|
{
|
|
4804
4830
|
"id": "ac55e6cb-5c61-43a8-b4bb-b7f15740a3ce",
|
|
4805
4831
|
"name": "Register cloud device - Register",
|
|
@@ -5198,7 +5224,7 @@
|
|
|
5198
5224
|
},
|
|
5199
5225
|
"response": {
|
|
5200
5226
|
"status": 200,
|
|
5201
|
-
"body": "{\n \"annualRevenue\": 1000,\n \"averageMonthlyVolume\": 1000,\n \"averageTicketAmount\": 1000,\n \"bAddress1\": \"123 Walnut Street\",\n \"bAddress2\": \"Suite 103\",\n \"bankData\": [\n {\n \"accountNumber\": \"123123123\",\n \"bankAccountFunction\": 1,\n \"bankAccountHolderName\": \"Gruzya Adventure Outfitters LLC\",\n \"bankAccountHolderType\": \"Business\",\n \"bankName\": \"Test Bank\",\n \"nickname\": \"Withdrawal Account\",\n \"routingAccount\": \"123123123\",\n \"typeAccount\": \"Checking\",\n \"accountId\": \"123-456\"\n },\n {\n \"accountNumber\": \"123123123\",\n \"bankAccountFunction\": 0,\n \"bankAccountHolderName\": \"Gruzya Adventure Outfitters LLC\",\n \"bankAccountHolderType\": \"Business\",\n \"bankName\": \"Test Bank\",\n \"nickname\": \"Deposit Account\",\n \"routingAccount\": \"123123123\",\n \"typeAccount\": \"Checking\",\n \"accountId\": \"123-456\"\n }\n ],\n \"bCity\": \"New Vegas\",\n \"bCountry\": \"US\",\n \"bFax\": \"5551234567\",\n \"binPerson\": 60,\n \"binPhone\": 20,\n \"binWeb\": 20,\n \"boardingLinkId\": 91,\n \"boardingStatus\": 123,\n \"boardingSubStatus\": 123,\n \"bPhone\": \"5551234567\",\n \"bStartdate\": \"01/01/1990\",\n \"bState\": \"FL\",\n \"bSummary\": \"Brick and mortar store that sells office supplies\",\n \"builderData\": {\n \"services\": {\n \"ach\": {\n \"acceptance\": {\n \"ccd\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"ppd\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"web\": {\n \"ro\": false,\n \"value\": \"<string>\"\n }\n },\n \"fees\": {\n \"body\": [\n {\n \"columns\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"header\": {\n \"columns\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n },\n \"price\": {\n \"body\": [\n {\n \"columns\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"header\": {\n \"columns\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n }\n },\n \"card\": {\n \"acceptance\": {\n \"amex\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"discover\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"mastercard\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"visa\": {\n \"ro\": false,\n \"value\": \"<string>\"\n }\n },\n \"fees\": {\n \"body\": [\n {\n \"columns\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"header\": {\n \"columns\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n },\n \"price\": {\n \"body\": [\n {\n \"columns\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"header\": {\n \"columns\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n }\n }\n },\n \"attributes\": {\n \"minimumDocuments\": 1,\n \"multipleContacts\": true,\n \"multipleOwners\": true\n },\n \"banking\": {\n \"depositAccount\": {\n \"accountNumber\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"bankName\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"routingAccount\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"typeAccount\": {\n \"ro\": false,\n \"value\": \"<string>\"\n }\n },\n \"withdrawalAccount\": {\n \"accountNumber\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"bankName\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"routingAccount\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"typeAccount\": {\n \"ro\": false,\n \"value\": \"<string>\"\n }\n }\n },\n \"business\": {\n \"address\": {\n \"baddress\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"baddress1\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"bcity\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"bcountry\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"bstate\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"bzip\": {\n \"ro\": false,\n \"validator\": \"zipcode\",\n \"value\": \"<string>\"\n },\n \"maddress\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"maddress1\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"mcity\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"mcountry\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"mstate\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"mzip\": {\n \"ro\": false,\n \"validator\": \"zipcode\",\n \"value\": \"<string>\"\n }\n },\n \"details\": {\n \"btype\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"dbaname\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"ein\": {\n \"ro\": false,\n \"validator\": \"routing\",\n \"value\": \"<string>\"\n },\n \"faxnumber\": {\n \"ro\": false,\n \"validator\": \"phone\",\n \"value\": \"<string>\"\n },\n \"legalname\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"license\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"licstate\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"phonenumber\": {\n \"ro\": false,\n \"validator\": \"phone\",\n \"value\": \"<string>\"\n },\n \"startdate\": {\n \"ro\": false,\n \"value\": \"2021-12-13T05:00:00.000Z\"\n },\n \"taxfillname\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"website\": {\n \"ro\": false,\n \"validator\": \"url\",\n \"value\": \"<string>\"\n }\n }\n },\n \"owners\": {\n \"contact_list\": {\n \"contactEmail\": {\n \"ro\": false,\n \"validator\": \"email\",\n \"value\": \"<string>\"\n },\n \"contactName\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"contactPhone\": {\n \"ro\": false,\n \"validator\": \"phone\",\n \"value\": \"<string>\"\n },\n \"contactTitle\": {\n \"ro\": false,\n \"validator\": \"alpha\",\n \"value\": \"<string>\"\n }\n },\n \"own_list\": {\n \"oaddress\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"ocity\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"ocountry\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"odriverstate\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"ostate\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"ownerdob\": {\n \"ro\": false,\n \"value\": \"2003-06-05T04:00:00.000Z\"\n },\n \"ownerdriver\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"owneremail\": {\n \"ro\": false,\n \"validator\": \"email\",\n \"value\": \"<string>\"\n },\n \"ownername\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"ownerpercent\": {\n \"ro\": false,\n \"validator\": \"number\",\n \"value\": \"<string>\"\n },\n \"ownerphone1\": {\n \"ro\": false,\n \"validator\": \"phone\",\n \"value\": \"<string>\"\n },\n \"ownerphone2\": {\n \"ro\": false,\n \"validator\": \"phone\",\n \"value\": \"<string>\"\n },\n \"ownerssn\": {\n \"ro\": false,\n \"validator\": \"routing\",\n \"value\": \"<string>\"\n },\n \"ownertitle\": {\n \"ro\": false,\n \"validator\": \"alpha\",\n \"value\": \"<string>\"\n },\n \"ozip\": {\n \"ro\": false,\n \"validator\": \"zipcode\",\n \"value\": \"<string>\"\n }\n }\n },\n \"processing\": {\n \"avgmonthly\": {\n \"ro\": false,\n \"validator\": \"numbers\",\n \"value\": \"<string>\"\n },\n \"binperson\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"binphone\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"binweb\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"bsummary\": {\n \"ro\": false,\n \"validator\": \"text\",\n \"value\": \"<string>\"\n },\n \"highticketamt\": {\n \"ro\": false,\n \"validator\": \"numbers\",\n \"value\": \"<string>\"\n },\n \"mcc\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"ticketamt\": {\n \"ro\": false,\n \"validator\": \"numbers\",\n \"value\": \"<string>\"\n },\n \"whenCharged\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"whenDelivered\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"whenProvided\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"whenRefunded\": {\n \"ro\": false,\n \"value\": \"<string>\"\n }\n }\n },\n \"bZip\": \"33000\",\n \"contactData\": [\n {\n \"contactEmail\": \"herman@hermanscoatings.com\",\n \"contactName\": \"Herman Martinez\",\n \"contactPhone\": \"3055550000\",\n \"contactTitle\": \"Owner\",\n \"additionalData\": null\n }\n ],\n \"createdAt\": \"2022-07-01T15:00:01Z\",\n \"dbaName\": \"Sunshine Gutters\",\n \"documentsRef\": {\n \"filelist\": [\n {\n \"originalName\": \"<string>\",\n \"zipName\": \"<string>\"\n }\n ],\n \"zipfile\": \"zx45.zip\"\n },\n \"ein\": \"XXXX6789\",\n \"externalPaypointId\": \"Paypoint-100\",\n \"generalEvents\": [\n {\n \"description\": \"Created\",\n \"eventTime\": \"2022-06-17T16:35:21Z\"\n },\n {\n \"description\": \"Updated Status\",\n \"eventTime\": \"2022-06-17T16:35:22Z\",\n \"refData\": \"1\"\n }\n ],\n \"highTicketAmount\": 1000,\n \"idApplication\": 325,\n \"lastModified\": \"2022-07-01T15:00:01Z\",\n \"legalName\": \"Sunshine Services, LLC\",\n \"license\": \"2222222FFG\",\n \"licenseState\": \"CA\",\n \"logo\": \"https://mysite.com/my-logo.png\",\n \"mAddress1\": \"123 Walnut Street\",\n \"mAddress2\": \"STE 900\",\n \"mccid\": \"<string>\",\n \"mCity\": \"TN\",\n \"mCountry\": \"US\",\n \"messages\": [\n {\n \"content\": \"Requested business license and bank statements.\",\n \"createdAt\": \"2023-10-30T19:37:20Z\",\n \"currentApplicationStatus\": 3,\n \"currentApplicationSubStatus\": 2,\n \"id\": 261,\n \"messageType\": 1,\n \"originalApplicationStatus\": -99,\n \"originalApplicationSubStatus\": 0,\n \"roomId\": 6,\n \"userId\": 104,\n \"userName\": \"admin\"\n },\n {\n \"content\": \"TIN Failed, Need to reach out to merchant\",\n \"createdAt\": \"2023-10-25T18:41:55Z\",\n \"currentApplicationStatus\": 3,\n \"currentApplicationSubStatus\": 3,\n \"id\": 231,\n \"messageType\": 1,\n \"originalApplicationStatus\": -99,\n \"originalApplicationSubStatus\": 0,\n \"roomId\": 6,\n \"userId\": 104,\n \"userName\": \"admin\"\n },\n {\n \"content\": \"Application approved, finalizing agreement.\",\n \"createdAt\": \"2023-09-09T00:00:00Z\",\n \"currentApplicationStatus\": 7,\n \"currentApplicationSubStatus\": 5,\n \"id\": 3,\n \"messageType\": 1,\n \"originalApplicationStatus\": -99,\n \"originalApplicationSubStatus\": 0,\n \"roomId\": 6,\n \"userId\": 5,\n \"userName\": \"admin\"\n }\n ],\n \"mState\": \"TN\",\n \"mZip\": \"37615\",\n \"orgId\": 123,\n \"orgParentName\": \"PropertyManager Pro\",\n \"ownerData\": [\n {\n \"oaddress\": \"33 North St\",\n \"ocity\": \"Any City\",\n \"ocountry\": \"US\",\n \"odriverstate\": \"CA\",\n \"ostate\": \"CA\",\n \"ownerdob\": \"01/01/1990\",\n \"ownerdriver\": \"CA6677778\",\n \"owneremail\": \"test@email.com\",\n \"ownername\": \"John Smith\",\n \"ownerpercent\": 25,\n \"ownerphone1\": \"555888111\",\n \"ownerphone2\": \"555888111\",\n \"ownerssn\": \"123456789\",\n \"ownertitle\": \"CEO\",\n \"ozip\": \"55555\",\n \"additionalData\": null\n }\n ],\n \"ownType\": \"Limited Liability Company\",\n \"pageidentifier\": \"<string>\",\n \"recipientEmailNotification\": true,\n \"resumable\": true,\n \"salesCode\": \"<string>\",\n \"serviceData\": {\n \"ach\": {\n \"acceptCCD\": true,\n \"acceptPPD\": true,\n \"acceptWeb\": true\n },\n \"card\": {\n \"acceptAmex\": true,\n \"acceptDiscover\": true,\n \"acceptMastercard\": true,\n \"acceptVisa\": true\n },\n \"odp\": {\n \"allowAch\": true,\n \"allowChecks\": true,\n \"allowVCard\": true,\n \"processing_region\": \"US\",\n \"processor\": \"tysys\",\n \"issuerNetworkSettingsId\": \"12345678901234\"\n }\n },\n \"signer\": {\n \"address\": \"33 North St\",\n \"address1\": \"STE 900\",\n \"city\": \"Bristol\",\n \"country\": \"US\",\n \"dob\": \"01/01/1976\",\n \"email\": \"test@email.com\",\n \"name\": \"John Smith\",\n \"phone\": \"555888111\",\n \"ssn\": \"123456789\",\n \"state\": \"TN\",\n \"zip\": \"55555\",\n \"pciAttestation\": true,\n \"signedDocumentReference\": \"https://example.com/signed-document.pdf\",\n \"attestationDate\": \"04/20/2025\",\n \"signDate\": \"04/20/2025\",\n \"additionalData\": {\n \"deviceId\": \"499585-389fj484-3jcj8hj3\",\n \"session\": \"fifji4-fiu443-fn4843\",\n \"timeWithCompany\": \"6 Years\"\n }\n },\n \"taxfillname\": \"Sunshine LLC\",\n \"templateId\": 22,\n \"websiteAddress\": \"www.example.com\",\n \"whencharged\": \"When Service Provided\",\n \"whendelivered\": \"Over 30 Days\",\n \"whenProvided\": \"30 Days or Less\",\n \"whenrefund\": \"Exchange Only\"\n}",
|
|
5227
|
+
"body": "{\n \"annualRevenue\": 1000,\n \"averageMonthlyVolume\": 1000,\n \"averageTicketAmount\": 1000,\n \"bAddress1\": \"123 Walnut Street\",\n \"bAddress2\": \"Suite 103\",\n \"bankData\": [\n {\n \"accountNumber\": \"123123123\",\n \"bankAccountFunction\": 1,\n \"bankAccountHolderName\": \"Gruzya Adventure Outfitters LLC\",\n \"bankAccountHolderType\": \"Business\",\n \"bankName\": \"Test Bank\",\n \"nickname\": \"Withdrawal Account\",\n \"routingAccount\": \"123123123\",\n \"typeAccount\": \"Checking\",\n \"accountId\": \"123-456\"\n },\n {\n \"accountNumber\": \"123123123\",\n \"bankAccountFunction\": 0,\n \"bankAccountHolderName\": \"Gruzya Adventure Outfitters LLC\",\n \"bankAccountHolderType\": \"Business\",\n \"bankName\": \"Test Bank\",\n \"nickname\": \"Deposit Account\",\n \"routingAccount\": \"123123123\",\n \"typeAccount\": \"Checking\",\n \"accountId\": \"123-456\"\n }\n ],\n \"bCity\": \"New Vegas\",\n \"bCountry\": \"US\",\n \"bFax\": \"5551234567\",\n \"binPerson\": 60,\n \"binPhone\": 20,\n \"binWeb\": 20,\n \"boardingLinkId\": 91,\n \"boardingStatus\": 123,\n \"boardingSubStatus\": 123,\n \"bPhone\": \"5551234567\",\n \"bStartdate\": \"01/01/1990\",\n \"bState\": \"FL\",\n \"bSummary\": \"Brick and mortar store that sells office supplies\",\n \"builderData\": {\n \"services\": {\n \"ach\": {\n \"acceptance\": {\n \"ccd\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"ppd\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"web\": {\n \"ro\": false,\n \"value\": \"<string>\"\n }\n },\n \"fees\": {\n \"body\": [\n {\n \"columns\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"header\": {\n \"columns\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n },\n \"price\": {\n \"body\": [\n {\n \"columns\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"header\": {\n \"columns\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n }\n },\n \"card\": {\n \"acceptance\": {\n \"amex\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"discover\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"mastercard\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"visa\": {\n \"ro\": false,\n \"value\": \"<string>\"\n }\n },\n \"fees\": {\n \"body\": [\n {\n \"columns\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"header\": {\n \"columns\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n },\n \"price\": {\n \"body\": [\n {\n \"columns\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n ],\n \"header\": {\n \"columns\": [\n {\n \"value\": \"<string>\"\n }\n ]\n }\n }\n }\n },\n \"attributes\": {\n \"minimumDocuments\": 1,\n \"multipleContacts\": true,\n \"multipleOwners\": true\n },\n \"banking\": {\n \"depositAccount\": {\n \"accountNumber\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"bankName\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"routingAccount\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"typeAccount\": {\n \"ro\": false,\n \"value\": \"<string>\"\n }\n },\n \"withdrawalAccount\": {\n \"accountNumber\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"bankName\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"routingAccount\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"typeAccount\": {\n \"ro\": false,\n \"value\": \"<string>\"\n }\n }\n },\n \"business\": {\n \"address\": {\n \"baddress\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"baddress1\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"bcity\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"bcountry\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"bstate\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"bzip\": {\n \"ro\": false,\n \"validator\": \"zipcode\",\n \"value\": \"<string>\"\n },\n \"maddress\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"maddress1\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"mcity\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"mcountry\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"mstate\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"mzip\": {\n \"ro\": false,\n \"validator\": \"zipcode\",\n \"value\": \"<string>\"\n }\n },\n \"details\": {\n \"btype\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"dbaname\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"ein\": {\n \"ro\": false,\n \"validator\": \"routing\",\n \"value\": \"<string>\"\n },\n \"faxnumber\": {\n \"ro\": false,\n \"validator\": \"phone\",\n \"value\": \"<string>\"\n },\n \"legalname\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"license\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"licstate\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"phonenumber\": {\n \"ro\": false,\n \"validator\": \"phone\",\n \"value\": \"<string>\"\n },\n \"startdate\": {\n \"ro\": false,\n \"value\": \"2021-12-13T05:00:00.000Z\"\n },\n \"taxfillname\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"website\": {\n \"ro\": false,\n \"validator\": \"url\",\n \"value\": \"<string>\"\n }\n }\n },\n \"owners\": {\n \"contact_list\": {\n \"contactEmail\": {\n \"ro\": false,\n \"validator\": \"email\",\n \"value\": \"<string>\"\n },\n \"contactName\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"contactPhone\": {\n \"ro\": false,\n \"validator\": \"phone\",\n \"value\": \"<string>\"\n },\n \"contactTitle\": {\n \"ro\": false,\n \"validator\": \"alpha\",\n \"value\": \"<string>\"\n }\n },\n \"own_list\": {\n \"oaddress\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"ocity\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"ocountry\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"odriverstate\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"ostate\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"ownerdob\": {\n \"ro\": false,\n \"value\": \"2003-06-05T04:00:00.000Z\"\n },\n \"ownerdriver\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"owneremail\": {\n \"ro\": false,\n \"validator\": \"email\",\n \"value\": \"<string>\"\n },\n \"ownername\": {\n \"ro\": false,\n \"validator\": \"alphanumeric\",\n \"value\": \"<string>\"\n },\n \"ownerpercent\": {\n \"ro\": false,\n \"validator\": \"number\",\n \"value\": \"<string>\"\n },\n \"ownerphone1\": {\n \"ro\": false,\n \"validator\": \"phone\",\n \"value\": \"<string>\"\n },\n \"ownerphone2\": {\n \"ro\": false,\n \"validator\": \"phone\",\n \"value\": \"<string>\"\n },\n \"ownerssn\": {\n \"ro\": false,\n \"validator\": \"routing\",\n \"value\": \"<string>\"\n },\n \"ownertitle\": {\n \"ro\": false,\n \"validator\": \"alpha\",\n \"value\": \"<string>\"\n },\n \"ozip\": {\n \"ro\": false,\n \"validator\": \"zipcode\",\n \"value\": \"<string>\"\n }\n }\n },\n \"processing\": {\n \"avgmonthly\": {\n \"ro\": false,\n \"validator\": \"numbers\",\n \"value\": \"<string>\"\n },\n \"binperson\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"binphone\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"binweb\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"bsummary\": {\n \"ro\": false,\n \"validator\": \"text\",\n \"value\": \"<string>\"\n },\n \"highticketamt\": {\n \"ro\": false,\n \"validator\": \"numbers\",\n \"value\": \"<string>\"\n },\n \"mcc\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"ticketamt\": {\n \"ro\": false,\n \"validator\": \"numbers\",\n \"value\": \"<string>\"\n },\n \"whenCharged\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"whenDelivered\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"whenProvided\": {\n \"ro\": false,\n \"value\": \"<string>\"\n },\n \"whenRefunded\": {\n \"ro\": false,\n \"value\": \"<string>\"\n }\n }\n },\n \"bZip\": \"33000\",\n \"contactData\": [\n {\n \"contactEmail\": \"herman@hermanscoatings.com\",\n \"contactName\": \"Herman Martinez\",\n \"contactPhone\": \"3055550000\",\n \"contactTitle\": \"Owner\",\n \"additionalData\": null\n }\n ],\n \"createdAt\": \"2022-07-01T15:00:01Z\",\n \"dbaName\": \"Sunshine Gutters\",\n \"documentsRef\": {\n \"filelist\": [\n {\n \"originalName\": \"<string>\",\n \"zipName\": \"<string>\"\n }\n ],\n \"zipfile\": \"zx45.zip\"\n },\n \"ein\": \"XXXX6789\",\n \"externalPaypointId\": \"Paypoint-100\",\n \"generalEvents\": [\n {\n \"description\": \"Created\",\n \"eventTime\": \"2022-06-17T16:35:21Z\"\n },\n {\n \"description\": \"Updated Status\",\n \"eventTime\": \"2022-06-17T16:35:22Z\",\n \"refData\": \"1\"\n }\n ],\n \"highTicketAmount\": 1000,\n \"idApplication\": 325,\n \"lastModified\": \"2022-07-01T15:00:01Z\",\n \"legalName\": \"Sunshine Services, LLC\",\n \"license\": \"2222222FFG\",\n \"licenseState\": \"CA\",\n \"logo\": \"https://mysite.com/my-logo.png\",\n \"mAddress1\": \"123 Walnut Street\",\n \"mAddress2\": \"STE 900\",\n \"mccid\": \"<string>\",\n \"mCity\": \"TN\",\n \"mCountry\": \"US\",\n \"messages\": [\n {\n \"content\": \"Requested business license and bank statements.\",\n \"createdAt\": \"2023-10-30T19:37:20Z\",\n \"currentApplicationStatus\": 3,\n \"currentApplicationSubStatus\": 2,\n \"id\": 261,\n \"messageType\": 1,\n \"originalApplicationStatus\": -99,\n \"originalApplicationSubStatus\": 0,\n \"roomId\": 6,\n \"userId\": 104,\n \"userName\": \"admin\"\n },\n {\n \"content\": \"TIN Failed, Need to reach out to merchant\",\n \"createdAt\": \"2023-10-25T18:41:55Z\",\n \"currentApplicationStatus\": 3,\n \"currentApplicationSubStatus\": 3,\n \"id\": 231,\n \"messageType\": 1,\n \"originalApplicationStatus\": -99,\n \"originalApplicationSubStatus\": 0,\n \"roomId\": 6,\n \"userId\": 104,\n \"userName\": \"admin\"\n },\n {\n \"content\": \"Application approved, finalizing agreement.\",\n \"createdAt\": \"2023-09-09T00:00:00Z\",\n \"currentApplicationStatus\": 7,\n \"currentApplicationSubStatus\": 5,\n \"id\": 3,\n \"messageType\": 1,\n \"originalApplicationStatus\": -99,\n \"originalApplicationSubStatus\": 0,\n \"roomId\": 6,\n \"userId\": 5,\n \"userName\": \"admin\"\n }\n ],\n \"mState\": \"TN\",\n \"mZip\": \"37615\",\n \"orgId\": 123,\n \"orgParentName\": \"PropertyManager Pro\",\n \"ownerData\": [\n {\n \"oaddress\": \"33 North St\",\n \"ocity\": \"Any City\",\n \"ocountry\": \"US\",\n \"odriverstate\": \"CA\",\n \"ostate\": \"CA\",\n \"ownerdob\": \"01/01/1990\",\n \"ownerdriver\": \"CA6677778\",\n \"owneremail\": \"test@email.com\",\n \"ownername\": \"John Smith\",\n \"ownerpercent\": 25,\n \"ownerphone1\": \"555888111\",\n \"ownerphone2\": \"555888111\",\n \"ownerssn\": \"123456789\",\n \"ownertitle\": \"CEO\",\n \"ozip\": \"55555\",\n \"additionalData\": {}\n }\n ],\n \"ownType\": \"Limited Liability Company\",\n \"pageidentifier\": \"<string>\",\n \"recipientEmailNotification\": true,\n \"resumable\": true,\n \"salesCode\": \"<string>\",\n \"serviceData\": {\n \"ach\": {\n \"acceptCCD\": true,\n \"acceptPPD\": true,\n \"acceptWeb\": true\n },\n \"card\": {\n \"acceptAmex\": true,\n \"acceptDiscover\": true,\n \"acceptMastercard\": true,\n \"acceptVisa\": true\n },\n \"odp\": {\n \"allowAch\": true,\n \"allowChecks\": true,\n \"allowVCard\": true,\n \"processing_region\": \"US\",\n \"processor\": \"tysys\",\n \"issuerNetworkSettingsId\": \"12345678901234\"\n }\n },\n \"signer\": {\n \"address\": \"33 North St\",\n \"address1\": \"STE 900\",\n \"city\": \"Bristol\",\n \"country\": \"US\",\n \"dob\": \"01/01/1976\",\n \"email\": \"test@email.com\",\n \"name\": \"John Smith\",\n \"phone\": \"555888111\",\n \"ssn\": \"123456789\",\n \"state\": \"TN\",\n \"zip\": \"55555\",\n \"pciAttestation\": true,\n \"signedDocumentReference\": \"https://example.com/signed-document.pdf\",\n \"attestationDate\": \"04/20/2025\",\n \"signDate\": \"04/20/2025\",\n \"additionalData\": {\n \"deviceId\": \"499585-389fj484-3jcj8hj3\",\n \"session\": \"fifji4-fiu443-fn4843\",\n \"timeWithCompany\": \"6 Years\"\n }\n },\n \"taxfillname\": \"Sunshine LLC\",\n \"templateId\": 22,\n \"websiteAddress\": \"www.example.com\",\n \"whencharged\": \"When Service Provided\",\n \"whendelivered\": \"Over 30 Days\",\n \"whenProvided\": \"30 Days or Less\",\n \"whenrefund\": \"Exchange Only\"\n}",
|
|
5202
5228
|
"headers": {
|
|
5203
5229
|
"Content-Type": "application/json"
|
|
5204
5230
|
}
|
|
@@ -7262,7 +7288,7 @@
|
|
|
7262
7288
|
"method": "GET",
|
|
7263
7289
|
"pathParameters": {
|
|
7264
7290
|
"mode": {
|
|
7265
|
-
"equalTo": "
|
|
7291
|
+
"equalTo": "m12"
|
|
7266
7292
|
},
|
|
7267
7293
|
"freq": {
|
|
7268
7294
|
"equalTo": "m"
|
|
@@ -7274,7 +7300,7 @@
|
|
|
7274
7300
|
},
|
|
7275
7301
|
"response": {
|
|
7276
7302
|
"status": 200,
|
|
7277
|
-
"body": "[\n {\n \"
|
|
7303
|
+
"body": "[\n {\n \"statX\": \"2023-03\",\n \"inTransactions\": 45,\n \"inTransactionsVolume\": 12500.75\n }\n]",
|
|
7278
7304
|
"headers": {
|
|
7279
7305
|
"Content-Type": "application/json"
|
|
7280
7306
|
}
|
|
@@ -7299,7 +7325,7 @@
|
|
|
7299
7325
|
"method": "GET",
|
|
7300
7326
|
"pathParameters": {
|
|
7301
7327
|
"interval": {
|
|
7302
|
-
"equalTo": "
|
|
7328
|
+
"equalTo": "all"
|
|
7303
7329
|
},
|
|
7304
7330
|
"level": {
|
|
7305
7331
|
"equalTo": "2"
|
|
@@ -7311,7 +7337,7 @@
|
|
|
7311
7337
|
},
|
|
7312
7338
|
"response": {
|
|
7313
7339
|
"status": 200,
|
|
7314
|
-
"body": "[\n {\n \"
|
|
7340
|
+
"body": "[\n {\n \"interval\": \"30\",\n \"count\": 23,\n \"volume\": 1609.62\n },\n {\n \"interval\": \"60\",\n \"count\": 0,\n \"volume\": 0\n },\n {\n \"interval\": \"90\",\n \"count\": 0,\n \"volume\": 0\n },\n {\n \"interval\": \"+90\",\n \"count\": 0,\n \"volume\": 0\n }\n]",
|
|
7315
7341
|
"headers": {
|
|
7316
7342
|
"Content-Type": "application/json"
|
|
7317
7343
|
}
|
|
@@ -9400,6 +9426,6 @@
|
|
|
9400
9426
|
}
|
|
9401
9427
|
],
|
|
9402
9428
|
"meta": {
|
|
9403
|
-
"total":
|
|
9429
|
+
"total": 273
|
|
9404
9430
|
}
|
|
9405
9431
|
}
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: payabli
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 3.0.
|
|
4
|
+
version: 3.0.13
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Payabli
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: exe
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-09-
|
|
11
|
+
date: 2026-09-16 00:00:00.000000000 Z
|
|
12
12
|
dependencies: []
|
|
13
13
|
description: The Payabli Ruby library provides convenient access to the Payabli API
|
|
14
14
|
from Ruby.
|
|
@@ -240,12 +240,11 @@ files:
|
|
|
240
240
|
- lib/payabli/query/types/list_vendors_request.rb
|
|
241
241
|
- lib/payabli/statistic/client.rb
|
|
242
242
|
- lib/payabli/statistic/types/basic_stats_request.rb
|
|
243
|
-
- lib/payabli/statistic/types/customer_basic_stats_request.rb
|
|
244
|
-
- lib/payabli/statistic/types/sub_stats_request.rb
|
|
245
|
-
- lib/payabli/statistic/types/vendor_basic_stats_request.rb
|
|
246
243
|
- lib/payabli/subscription/client.rb
|
|
247
244
|
- lib/payabli/subscription/types/request_schedule.rb
|
|
248
245
|
- lib/payabli/subscription/types/request_update_schedule.rb
|
|
246
|
+
- lib/payabli/taptopay/client.rb
|
|
247
|
+
- lib/payabli/taptopay/types/tap_to_pay_activation_challenge_request.rb
|
|
249
248
|
- lib/payabli/templates/client.rb
|
|
250
249
|
- lib/payabli/templates/types/list_templates_request.rb
|
|
251
250
|
- lib/payabli/token/client.rb
|
|
@@ -1025,7 +1024,7 @@ files:
|
|
|
1025
1024
|
- lib/payabli/types/split_funding_content.rb
|
|
1026
1025
|
- lib/payabli/types/split_funding_refund_content.rb
|
|
1027
1026
|
- lib/payabli/types/stat_basic_extended_query_record.rb
|
|
1028
|
-
- lib/payabli/types/
|
|
1027
|
+
- lib/payabli/types/stat_customer_basic_query_record.rb
|
|
1029
1028
|
- lib/payabli/types/state_nullable.rb
|
|
1030
1029
|
- lib/payabli/types/state_transition_response.rb
|
|
1031
1030
|
- lib/payabli/types/statement_email_config.rb
|
|
@@ -1043,6 +1042,10 @@ files:
|
|
|
1043
1042
|
- lib/payabli/types/subscriptionid.rb
|
|
1044
1043
|
- lib/payabli/types/summary_commodity_code.rb
|
|
1045
1044
|
- lib/payabli/types/summary_org.rb
|
|
1045
|
+
- lib/payabli/types/tap_to_pay_activation_challenge_data.rb
|
|
1046
|
+
- lib/payabli/types/tap_to_pay_activation_challenge_error_response.rb
|
|
1047
|
+
- lib/payabli/types/tap_to_pay_activation_challenge_error_response_response_data.rb
|
|
1048
|
+
- lib/payabli/types/tap_to_pay_activation_challenge_response.rb
|
|
1046
1049
|
- lib/payabli/types/target.rb
|
|
1047
1050
|
- lib/payabli/types/tax.rb
|
|
1048
1051
|
- lib/payabli/types/taxfillname.rb
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Payabli
|
|
4
|
-
module Statistic
|
|
5
|
-
module Types
|
|
6
|
-
class CustomerBasicStatsRequest < Internal::Types::Model
|
|
7
|
-
field :mode, -> { String }, optional: false, nullable: false
|
|
8
|
-
|
|
9
|
-
field :freq, -> { String }, optional: false, nullable: false
|
|
10
|
-
|
|
11
|
-
field :customer_id, -> { Integer }, optional: false, nullable: false, api_name: "customerId"
|
|
12
|
-
|
|
13
|
-
field :parameters, -> { Internal::Types::Hash[String, String] }, optional: true, nullable: false
|
|
14
|
-
end
|
|
15
|
-
end
|
|
16
|
-
end
|
|
17
|
-
end
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Payabli
|
|
4
|
-
module Statistic
|
|
5
|
-
module Types
|
|
6
|
-
class SubStatsRequest < Internal::Types::Model
|
|
7
|
-
field :interval, -> { String }, optional: false, nullable: false
|
|
8
|
-
|
|
9
|
-
field :level, -> { Integer }, optional: false, nullable: false
|
|
10
|
-
|
|
11
|
-
field :entry_id, -> { Integer }, optional: false, nullable: false, api_name: "entryId"
|
|
12
|
-
|
|
13
|
-
field :parameters, -> { Internal::Types::Hash[String, String] }, optional: true, nullable: false
|
|
14
|
-
end
|
|
15
|
-
end
|
|
16
|
-
end
|
|
17
|
-
end
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module Payabli
|
|
4
|
-
module Statistic
|
|
5
|
-
module Types
|
|
6
|
-
class VendorBasicStatsRequest < Internal::Types::Model
|
|
7
|
-
field :mode, -> { String }, optional: false, nullable: false
|
|
8
|
-
|
|
9
|
-
field :freq, -> { String }, optional: false, nullable: false
|
|
10
|
-
|
|
11
|
-
field :id_vendor, -> { Integer }, optional: false, nullable: false, api_name: "idVendor"
|
|
12
|
-
|
|
13
|
-
field :parameters, -> { Internal::Types::Hash[String, String] }, optional: true, nullable: false
|
|
14
|
-
end
|
|
15
|
-
end
|
|
16
|
-
end
|
|
17
|
-
end
|