payabli 3.0.12 → 3.0.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.fern/metadata.json +4 -4
- data/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/bill_out_data.rb +1 -1
- data/lib/payabli/types/bill_pay_out_data.rb +1 -1
- data/lib/payabli/types/bill_pay_out_data_request.rb +1 -1
- data/lib/payabli/types/bill_response_data.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/types/user_data.rb +1 -1
- data/lib/payabli/types/user_query_record.rb +1 -1
- data/lib/payabli/types/v_card_get_response_associated_vendor.rb +1 -1
- data/lib/payabli/types/vendor_query_record.rb +53 -53
- data/lib/payabli/vendor/client.rb +3 -3
- data/lib/payabli/version.rb +1 -1
- data/lib/payabli.rb +13 -10
- data/reference.md +111 -55
- data/wiremock/wiremock-mappings.json +43 -17
- 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
|
@@ -3,111 +3,111 @@
|
|
|
3
3
|
module Payabli
|
|
4
4
|
module Types
|
|
5
5
|
class VendorQueryRecord < Internal::Types::Model
|
|
6
|
-
field :vendor_number, -> { String }, optional:
|
|
6
|
+
field :vendor_number, -> { String }, optional: false, nullable: false, api_name: "VendorNumber"
|
|
7
7
|
|
|
8
|
-
field :name_1, -> { String }, optional:
|
|
8
|
+
field :name_1, -> { String }, optional: false, nullable: false, api_name: "Name1"
|
|
9
9
|
|
|
10
|
-
field :name_2, -> { String }, optional:
|
|
10
|
+
field :name_2, -> { String }, optional: false, nullable: true, api_name: "Name2"
|
|
11
11
|
|
|
12
|
-
field :ein, -> { String }, optional:
|
|
12
|
+
field :ein, -> { String }, optional: false, nullable: true, api_name: "EIN"
|
|
13
13
|
|
|
14
|
-
field :phone, -> { String }, optional:
|
|
14
|
+
field :phone, -> { String }, optional: false, nullable: true, api_name: "Phone"
|
|
15
15
|
|
|
16
|
-
field :email, -> { String }, optional:
|
|
16
|
+
field :email, -> { String }, optional: false, nullable: true, api_name: "Email"
|
|
17
17
|
|
|
18
|
-
field :remit_email, -> { String }, optional:
|
|
18
|
+
field :remit_email, -> { String }, optional: false, nullable: true, api_name: "RemitEmail"
|
|
19
19
|
|
|
20
|
-
field :address_1, -> { String }, optional:
|
|
20
|
+
field :address_1, -> { String }, optional: false, nullable: true, api_name: "Address1"
|
|
21
21
|
|
|
22
|
-
field :address_2, -> { String }, optional:
|
|
22
|
+
field :address_2, -> { String }, optional: false, nullable: true, api_name: "Address2"
|
|
23
23
|
|
|
24
|
-
field :city, -> { String }, optional:
|
|
24
|
+
field :city, -> { String }, optional: false, nullable: true, api_name: "City"
|
|
25
25
|
|
|
26
|
-
field :state, -> { String }, optional:
|
|
26
|
+
field :state, -> { String }, optional: false, nullable: true, api_name: "State"
|
|
27
27
|
|
|
28
|
-
field :zip, -> { String }, optional:
|
|
28
|
+
field :zip, -> { String }, optional: false, nullable: true, api_name: "Zip"
|
|
29
29
|
|
|
30
|
-
field :country, -> { String }, optional:
|
|
30
|
+
field :country, -> { String }, optional: false, nullable: true, api_name: "Country"
|
|
31
31
|
|
|
32
|
-
field :mcc, -> { String }, optional:
|
|
32
|
+
field :mcc, -> { String }, optional: false, nullable: true, api_name: "Mcc"
|
|
33
33
|
|
|
34
|
-
field :location_code, -> { String }, optional:
|
|
34
|
+
field :location_code, -> { String }, optional: false, nullable: true, api_name: "LocationCode"
|
|
35
35
|
|
|
36
|
-
field :contacts, -> { Internal::Types::Array[Payabli::Types::ContactsResponse] }, optional:
|
|
36
|
+
field :contacts, -> { Internal::Types::Array[Payabli::Types::ContactsResponse] }, optional: false, nullable: true, api_name: "Contacts"
|
|
37
37
|
|
|
38
|
-
field :billing_data, -> { Payabli::Types::BillingDataResponse }, optional:
|
|
38
|
+
field :billing_data, -> { Payabli::Types::BillingDataResponse }, optional: false, nullable: true, api_name: "BillingData"
|
|
39
39
|
|
|
40
|
-
field :payment_method, -> { String }, optional:
|
|
40
|
+
field :payment_method, -> { String }, optional: false, nullable: true, api_name: "PaymentMethod"
|
|
41
41
|
|
|
42
|
-
field :vendor_status, -> { Integer }, optional:
|
|
42
|
+
field :vendor_status, -> { Integer }, optional: false, nullable: false, api_name: "VendorStatus"
|
|
43
43
|
|
|
44
|
-
field :vendor_id, -> { Integer }, optional:
|
|
44
|
+
field :vendor_id, -> { Integer }, optional: false, nullable: false, api_name: "VendorId"
|
|
45
45
|
|
|
46
|
-
field :enrollment_status, -> { String }, optional:
|
|
46
|
+
field :enrollment_status, -> { String }, optional: false, nullable: true, api_name: "EnrollmentStatus"
|
|
47
47
|
|
|
48
|
-
field :summary, -> { Payabli::Types::VendorSummary }, optional:
|
|
48
|
+
field :summary, -> { Payabli::Types::VendorSummary }, optional: false, nullable: true, api_name: "Summary"
|
|
49
49
|
|
|
50
|
-
field :paypoint_legalname, -> { String }, optional:
|
|
50
|
+
field :paypoint_legalname, -> { String }, optional: false, nullable: false, api_name: "PaypointLegalname"
|
|
51
51
|
|
|
52
|
-
field :paypoint_id, -> { Integer }, optional:
|
|
52
|
+
field :paypoint_id, -> { Integer }, optional: false, nullable: true, api_name: "PaypointId"
|
|
53
53
|
|
|
54
|
-
field :paypoint_dbaname, -> { String }, optional:
|
|
54
|
+
field :paypoint_dbaname, -> { String }, optional: false, nullable: false, api_name: "PaypointDbaname"
|
|
55
55
|
|
|
56
|
-
field :paypoint_entryname, -> { String }, optional:
|
|
56
|
+
field :paypoint_entryname, -> { String }, optional: false, nullable: false, api_name: "PaypointEntryname"
|
|
57
57
|
|
|
58
|
-
field :parent_org_name, -> { String }, optional:
|
|
58
|
+
field :parent_org_name, -> { String }, optional: false, nullable: false, api_name: "ParentOrgName"
|
|
59
59
|
|
|
60
|
-
field :parent_org_id, -> { Integer }, optional:
|
|
60
|
+
field :parent_org_id, -> { Integer }, optional: false, nullable: false, api_name: "ParentOrgId"
|
|
61
61
|
|
|
62
|
-
field :created_date, -> { String }, optional:
|
|
62
|
+
field :created_date, -> { String }, optional: false, nullable: false, api_name: "CreatedDate"
|
|
63
63
|
|
|
64
|
-
field :last_updated, -> { String }, optional:
|
|
64
|
+
field :last_updated, -> { String }, optional: false, nullable: false, api_name: "LastUpdated"
|
|
65
65
|
|
|
66
|
-
field :remit_address_1, -> { String }, optional:
|
|
66
|
+
field :remit_address_1, -> { String }, optional: false, nullable: true, api_name: "remitAddress1"
|
|
67
67
|
|
|
68
|
-
field :remit_address_2, -> { String }, optional:
|
|
68
|
+
field :remit_address_2, -> { String }, optional: false, nullable: true, api_name: "remitAddress2"
|
|
69
69
|
|
|
70
|
-
field :remit_city, -> { String }, optional:
|
|
70
|
+
field :remit_city, -> { String }, optional: false, nullable: true, api_name: "remitCity"
|
|
71
71
|
|
|
72
|
-
field :remit_state, -> { String }, optional:
|
|
72
|
+
field :remit_state, -> { String }, optional: false, nullable: true, api_name: "remitState"
|
|
73
73
|
|
|
74
|
-
field :remit_zip, -> { String }, optional:
|
|
74
|
+
field :remit_zip, -> { String }, optional: false, nullable: true, api_name: "remitZip"
|
|
75
75
|
|
|
76
|
-
field :remit_country, -> { String }, optional:
|
|
76
|
+
field :remit_country, -> { String }, optional: false, nullable: true, api_name: "remitCountry"
|
|
77
77
|
|
|
78
|
-
field :payee_name_1, -> { String }, optional:
|
|
78
|
+
field :payee_name_1, -> { String }, optional: false, nullable: true, api_name: "payeeName1"
|
|
79
79
|
|
|
80
|
-
field :payee_name_2, -> { String }, optional:
|
|
80
|
+
field :payee_name_2, -> { String }, optional: false, nullable: true, api_name: "payeeName2"
|
|
81
81
|
|
|
82
|
-
field :custom_field_1, -> { String }, optional:
|
|
82
|
+
field :custom_field_1, -> { String }, optional: false, nullable: true, api_name: "customField1"
|
|
83
83
|
|
|
84
|
-
field :custom_field_2, -> { String }, optional:
|
|
84
|
+
field :custom_field_2, -> { String }, optional: false, nullable: true, api_name: "customField2"
|
|
85
85
|
|
|
86
|
-
field :customer_vendor_account, -> { String }, optional:
|
|
86
|
+
field :customer_vendor_account, -> { String }, optional: false, nullable: true, api_name: "customerVendorAccount"
|
|
87
87
|
|
|
88
|
-
field :internal_reference_id, -> { Integer }, optional:
|
|
88
|
+
field :internal_reference_id, -> { Integer }, optional: false, nullable: false, api_name: "InternalReferenceId"
|
|
89
89
|
|
|
90
|
-
field :payment_portal_url, -> { String }, optional:
|
|
90
|
+
field :payment_portal_url, -> { String }, optional: false, nullable: true, api_name: "PaymentPortalUrl"
|
|
91
91
|
|
|
92
|
-
field :card_accepted, -> { String }, optional:
|
|
92
|
+
field :card_accepted, -> { String }, optional: false, nullable: true, api_name: "CardAccepted"
|
|
93
93
|
|
|
94
|
-
field :ach_accepted, -> { String }, optional:
|
|
94
|
+
field :ach_accepted, -> { String }, optional: false, nullable: true, api_name: "AchAccepted"
|
|
95
95
|
|
|
96
|
-
field :check_accepted, -> { String }, optional:
|
|
96
|
+
field :check_accepted, -> { String }, optional: false, nullable: true, api_name: "CheckAccepted"
|
|
97
97
|
|
|
98
|
-
field :enrichment_status, -> { String }, optional:
|
|
98
|
+
field :enrichment_status, -> { String }, optional: false, nullable: false, api_name: "EnrichmentStatus"
|
|
99
99
|
|
|
100
|
-
field :enriched_by, -> { String }, optional:
|
|
100
|
+
field :enriched_by, -> { String }, optional: false, nullable: true, api_name: "EnrichedBy"
|
|
101
101
|
|
|
102
|
-
field :enriched_at, -> { String }, optional:
|
|
102
|
+
field :enriched_at, -> { String }, optional: false, nullable: true, api_name: "EnrichedAt"
|
|
103
103
|
|
|
104
|
-
field :enrichment_id, -> { String }, optional:
|
|
104
|
+
field :enrichment_id, -> { String }, optional: false, nullable: true, api_name: "EnrichmentId"
|
|
105
105
|
|
|
106
|
-
field :additional_data, -> { Internal::Types::Hash[String, String] }, optional:
|
|
106
|
+
field :additional_data, -> { Internal::Types::Hash[String, String] }, optional: false, nullable: true, api_name: "additionalData"
|
|
107
107
|
|
|
108
|
-
field :external_paypoint_id, -> { String }, optional:
|
|
108
|
+
field :external_paypoint_id, -> { String }, optional: false, nullable: true, api_name: "externalPaypointID"
|
|
109
109
|
|
|
110
|
-
field :stored_methods, -> { Internal::Types::Array[Payabli::Types::VendorResponseStoredMethod] }, optional:
|
|
110
|
+
field :stored_methods, -> { Internal::Types::Array[Payabli::Types::VendorResponseStoredMethod] }, optional: false, nullable: true, api_name: "StoredMethods"
|
|
111
111
|
end
|
|
112
112
|
end
|
|
113
113
|
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
|
@@ -39,7 +39,7 @@ require_relative "payabli/billing/types/get_profile_billing_request_service_grou
|
|
|
39
39
|
require_relative "payabli/billing/types/get_profile_billing_request_entity_type"
|
|
40
40
|
require_relative "payabli/types/idempotency_key"
|
|
41
41
|
require_relative "payabli/types/accounting_field"
|
|
42
|
-
require_relative "payabli/types/
|
|
42
|
+
require_relative "payabli/types/additional_data_map"
|
|
43
43
|
require_relative "payabli/types/file_content_ftype"
|
|
44
44
|
require_relative "payabli/types/file_content"
|
|
45
45
|
require_relative "payabli/types/attachments"
|
|
@@ -85,7 +85,6 @@ require_relative "payabli/types/remitzip"
|
|
|
85
85
|
require_relative "payabli/types/remitcountry"
|
|
86
86
|
require_relative "payabli/types/payee_name"
|
|
87
87
|
require_relative "payabli/types/internal_reference_id"
|
|
88
|
-
require_relative "payabli/types/additional_data_map"
|
|
89
88
|
require_relative "payabli/types/bin_data"
|
|
90
89
|
require_relative "payabli/types/vendor_response_stored_method"
|
|
91
90
|
require_relative "payabli/types/vendor_data_response"
|
|
@@ -93,10 +92,6 @@ require_relative "payabli/types/created_at"
|
|
|
93
92
|
require_relative "payabli/types/last_modified"
|
|
94
93
|
require_relative "payabli/types/ein"
|
|
95
94
|
require_relative "payabli/types/remit_email"
|
|
96
|
-
require_relative "payabli/types/address_nullable"
|
|
97
|
-
require_relative "payabli/types/address_addtl_nullable"
|
|
98
|
-
require_relative "payabli/types/city_nullable"
|
|
99
|
-
require_relative "payabli/types/state_nullable"
|
|
100
95
|
require_relative "payabli/types/zip"
|
|
101
96
|
require_relative "payabli/types/account_id"
|
|
102
97
|
require_relative "payabli/types/bank_name"
|
|
@@ -176,7 +171,10 @@ require_relative "payabli/types/totalrecords"
|
|
|
176
171
|
require_relative "payabli/types/bill_query_response_summary"
|
|
177
172
|
require_relative "payabli/types/bill_query_record_2_payment_method"
|
|
178
173
|
require_relative "payabli/types/additional_data"
|
|
174
|
+
require_relative "payabli/types/address_nullable"
|
|
175
|
+
require_relative "payabli/types/address_addtl_nullable"
|
|
179
176
|
require_relative "payabli/types/billing_data"
|
|
177
|
+
require_relative "payabli/types/additional_data_string"
|
|
180
178
|
require_relative "payabli/types/contacts"
|
|
181
179
|
require_relative "payabli/types/contacts_field"
|
|
182
180
|
require_relative "payabli/types/vendor_payment_method"
|
|
@@ -442,6 +440,7 @@ require_relative "payabli/types/bank_account_function"
|
|
|
442
440
|
require_relative "payabli/types/bank"
|
|
443
441
|
require_relative "payabli/types/bank_data"
|
|
444
442
|
require_relative "payabli/types/boarding_id"
|
|
443
|
+
require_relative "payabli/types/city_nullable"
|
|
445
444
|
require_relative "payabli/types/country_nullable"
|
|
446
445
|
require_relative "payabli/types/min_ticket"
|
|
447
446
|
require_relative "payabli/types/max_ticket"
|
|
@@ -457,6 +456,7 @@ require_relative "payabli/types/card_setup"
|
|
|
457
456
|
require_relative "payabli/types/odp_setup_processing_region"
|
|
458
457
|
require_relative "payabli/types/odp_setup"
|
|
459
458
|
require_relative "payabli/types/services"
|
|
459
|
+
require_relative "payabli/types/state_nullable"
|
|
460
460
|
require_relative "payabli/types/paypoint_summary"
|
|
461
461
|
require_relative "payabli/types/website"
|
|
462
462
|
require_relative "payabli/types/statement_email_config"
|
|
@@ -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
|
)
|