payabli 2.2.14 → 2.2.16
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/.rubocop.yml +10 -1
- data/README.md +11 -11
- data/lib/payabli/client.rb +1 -1
- data/lib/payabli/money_out/client.rb +50 -0
- data/lib/payabli/money_out_types/types/allowed_check_payment_status.rb +14 -0
- data/lib/payabli/query_types/types/transfer_out_detail_record.rb +0 -1
- data/lib/payabli/types/payment_detail.rb +1 -0
- data/lib/payabli/version.rb +1 -1
- data/lib/payabli.rb +1 -0
- data/reference.md +894 -810
- data/wiremock/wiremock-mappings.json +1 -1
- metadata +2 -1
data/reference.md
CHANGED
|
@@ -28,41 +28,41 @@ Creates a bill in an entrypoint.
|
|
|
28
28
|
|
|
29
29
|
```ruby
|
|
30
30
|
client.bill.add_bill(
|
|
31
|
-
entry:
|
|
32
|
-
accounting_field_1:
|
|
31
|
+
entry: "8cfec329267",
|
|
32
|
+
accounting_field_1: "MyInternalId",
|
|
33
33
|
attachments: [{
|
|
34
|
-
ftype:
|
|
35
|
-
filename:
|
|
36
|
-
furl:
|
|
34
|
+
ftype: "pdf",
|
|
35
|
+
filename: "my-doc.pdf",
|
|
36
|
+
furl: "https://mysite.com/my-doc.pdf"
|
|
37
37
|
}],
|
|
38
|
-
bill_date:
|
|
38
|
+
bill_date: "2024-07-01",
|
|
39
39
|
bill_items: [{
|
|
40
|
-
item_product_code:
|
|
41
|
-
item_product_name:
|
|
42
|
-
item_description:
|
|
43
|
-
item_commodity_code:
|
|
44
|
-
item_unit_of_measure:
|
|
40
|
+
item_product_code: "M-DEPOSIT",
|
|
41
|
+
item_product_name: "Materials deposit",
|
|
42
|
+
item_description: "Deposit for materials",
|
|
43
|
+
item_commodity_code: "010",
|
|
44
|
+
item_unit_of_measure: "SqFt",
|
|
45
45
|
item_cost: 5,
|
|
46
46
|
item_qty: 1,
|
|
47
47
|
item_mode: 0,
|
|
48
|
-
item_categories: [
|
|
48
|
+
item_categories: ["deposits"],
|
|
49
49
|
item_total_amount: 123,
|
|
50
50
|
item_tax_amount: 7,
|
|
51
51
|
item_tax_rate: 0.075
|
|
52
52
|
}],
|
|
53
|
-
bill_number:
|
|
54
|
-
comments:
|
|
55
|
-
due_date:
|
|
56
|
-
end_date:
|
|
57
|
-
frequency:
|
|
53
|
+
bill_number: "ABC-123",
|
|
54
|
+
comments: "Deposit for materials",
|
|
55
|
+
due_date: "2024-07-01",
|
|
56
|
+
end_date: "2024-07-01",
|
|
57
|
+
frequency: "monthly",
|
|
58
58
|
mode: 0,
|
|
59
59
|
net_amount: 3762.87,
|
|
60
60
|
status: -99,
|
|
61
|
-
terms:
|
|
61
|
+
terms: "NET30",
|
|
62
62
|
vendor: {
|
|
63
|
-
vendor_number:
|
|
63
|
+
vendor_number: "1234-A"
|
|
64
64
|
}
|
|
65
|
-
)
|
|
65
|
+
)
|
|
66
66
|
```
|
|
67
67
|
</dd>
|
|
68
68
|
</dl>
|
|
@@ -141,9 +141,9 @@ Delete a file attached to a bill.
|
|
|
141
141
|
|
|
142
142
|
```ruby
|
|
143
143
|
client.bill.delete_attached_from_bill(
|
|
144
|
-
filename:
|
|
144
|
+
filename: "0_Bill.pdf",
|
|
145
145
|
id_bill: 285
|
|
146
|
-
)
|
|
146
|
+
)
|
|
147
147
|
```
|
|
148
148
|
</dd>
|
|
149
149
|
</dl>
|
|
@@ -238,7 +238,7 @@ Deletes a bill by ID.
|
|
|
238
238
|
<dd>
|
|
239
239
|
|
|
240
240
|
```ruby
|
|
241
|
-
client.bill.delete_bill(id_bill: 285)
|
|
241
|
+
client.bill.delete_bill(id_bill: 285)
|
|
242
242
|
```
|
|
243
243
|
</dd>
|
|
244
244
|
</dl>
|
|
@@ -302,9 +302,9 @@ Updates a bill by ID.
|
|
|
302
302
|
```ruby
|
|
303
303
|
client.bill.edit_bill(
|
|
304
304
|
id_bill: 285,
|
|
305
|
-
bill_date:
|
|
305
|
+
bill_date: "2025-07-01",
|
|
306
306
|
net_amount: 3762.87
|
|
307
|
-
)
|
|
307
|
+
)
|
|
308
308
|
```
|
|
309
309
|
</dd>
|
|
310
310
|
</dl>
|
|
@@ -375,10 +375,10 @@ Retrieves a file attached to a bill, either as a binary file or as a Base64-enco
|
|
|
375
375
|
|
|
376
376
|
```ruby
|
|
377
377
|
client.bill.get_attached_from_bill(
|
|
378
|
-
filename:
|
|
378
|
+
filename: "0_Bill.pdf",
|
|
379
379
|
id_bill: 285,
|
|
380
380
|
return_object: true
|
|
381
|
-
)
|
|
381
|
+
)
|
|
382
382
|
```
|
|
383
383
|
</dd>
|
|
384
384
|
</dl>
|
|
@@ -468,7 +468,7 @@ Retrieves a bill by ID from an entrypoint.
|
|
|
468
468
|
<dd>
|
|
469
469
|
|
|
470
470
|
```ruby
|
|
471
|
-
client.bill.get_bill(id_bill: 285)
|
|
471
|
+
client.bill.get_bill(id_bill: 285)
|
|
472
472
|
```
|
|
473
473
|
</dd>
|
|
474
474
|
</dl>
|
|
@@ -531,11 +531,11 @@ Retrieve a list of bills for an entrypoint. Use filters to limit results. Includ
|
|
|
531
531
|
|
|
532
532
|
```ruby
|
|
533
533
|
client.bill.list_bills(
|
|
534
|
-
entry:
|
|
534
|
+
entry: "8cfec329267",
|
|
535
535
|
from_record: 251,
|
|
536
536
|
limit_record: 0,
|
|
537
|
-
sort_by:
|
|
538
|
-
)
|
|
537
|
+
sort_by: "desc(field_name)"
|
|
538
|
+
)
|
|
539
539
|
```
|
|
540
540
|
</dd>
|
|
541
541
|
</dl>
|
|
@@ -685,8 +685,8 @@ client.bill.list_bills_org(
|
|
|
685
685
|
org_id: 123,
|
|
686
686
|
from_record: 251,
|
|
687
687
|
limit_record: 0,
|
|
688
|
-
sort_by:
|
|
689
|
-
)
|
|
688
|
+
sort_by: "desc(field_name)"
|
|
689
|
+
)
|
|
690
690
|
```
|
|
691
691
|
</dd>
|
|
692
692
|
</dl>
|
|
@@ -834,8 +834,8 @@ Modify the list of users the bill is sent to for approval.
|
|
|
834
834
|
```ruby
|
|
835
835
|
client.bill.modify_approval_bill(
|
|
836
836
|
id_bill: 285,
|
|
837
|
-
request: [
|
|
838
|
-
)
|
|
837
|
+
request: ["string"]
|
|
838
|
+
)
|
|
839
839
|
```
|
|
840
840
|
</dd>
|
|
841
841
|
</dl>
|
|
@@ -907,9 +907,9 @@ Send a bill to a user or list of users to approve.
|
|
|
907
907
|
```ruby
|
|
908
908
|
client.bill.send_to_approval_bill(
|
|
909
909
|
id_bill: 285,
|
|
910
|
-
idempotency_key:
|
|
911
|
-
body: [
|
|
912
|
-
)
|
|
910
|
+
idempotency_key: "6B29FC40-CA47-1067-B31D-00DD010662DA",
|
|
911
|
+
body: ["string"]
|
|
912
|
+
)
|
|
913
913
|
```
|
|
914
914
|
</dd>
|
|
915
915
|
</dl>
|
|
@@ -996,9 +996,9 @@ Approve or disapprove a bill by ID.
|
|
|
996
996
|
|
|
997
997
|
```ruby
|
|
998
998
|
client.bill.set_approved_bill(
|
|
999
|
-
approved:
|
|
999
|
+
approved: "true",
|
|
1000
1000
|
id_bill: 285
|
|
1001
|
-
)
|
|
1001
|
+
)
|
|
1002
1002
|
```
|
|
1003
1003
|
</dd>
|
|
1004
1004
|
</dl>
|
|
@@ -1088,93 +1088,93 @@ client.boarding.add_application(
|
|
|
1088
1088
|
}
|
|
1089
1089
|
},
|
|
1090
1090
|
annual_revenue: 1000,
|
|
1091
|
-
average_bill_size:
|
|
1092
|
-
average_monthly_bill:
|
|
1091
|
+
average_bill_size: "500",
|
|
1092
|
+
average_monthly_bill: "5650",
|
|
1093
1093
|
avgmonthly: 1000,
|
|
1094
|
-
baddress:
|
|
1095
|
-
baddress_1:
|
|
1094
|
+
baddress: "123 Walnut Street",
|
|
1095
|
+
baddress_1: "Suite 103",
|
|
1096
1096
|
bank_data: {},
|
|
1097
|
-
bcity:
|
|
1098
|
-
bcountry:
|
|
1097
|
+
bcity: "New Vegas",
|
|
1098
|
+
bcountry: "US",
|
|
1099
1099
|
binperson: 60,
|
|
1100
1100
|
binphone: 20,
|
|
1101
1101
|
binweb: 20,
|
|
1102
|
-
bstate:
|
|
1103
|
-
bsummary:
|
|
1104
|
-
btype:
|
|
1105
|
-
bzip:
|
|
1102
|
+
bstate: "FL",
|
|
1103
|
+
bsummary: "Brick and mortar store that sells office supplies",
|
|
1104
|
+
btype: "Limited Liability Company",
|
|
1105
|
+
bzip: "33000",
|
|
1106
1106
|
contacts: [{
|
|
1107
|
-
contact_email:
|
|
1108
|
-
contact_name:
|
|
1109
|
-
contact_phone:
|
|
1110
|
-
contact_title:
|
|
1107
|
+
contact_email: "herman@hermanscoatings.com",
|
|
1108
|
+
contact_name: "Herman Martinez",
|
|
1109
|
+
contact_phone: "3055550000",
|
|
1110
|
+
contact_title: "Owner"
|
|
1111
1111
|
}],
|
|
1112
|
-
credit_limit:
|
|
1113
|
-
dba_name:
|
|
1114
|
-
ein:
|
|
1115
|
-
faxnumber:
|
|
1112
|
+
credit_limit: "creditLimit",
|
|
1113
|
+
dba_name: "Sunshine Gutters",
|
|
1114
|
+
ein: "123456789",
|
|
1115
|
+
faxnumber: "1234567890",
|
|
1116
1116
|
highticketamt: 1000,
|
|
1117
|
-
legal_name:
|
|
1118
|
-
license:
|
|
1119
|
-
licstate:
|
|
1120
|
-
maddress:
|
|
1121
|
-
maddress_1:
|
|
1122
|
-
mcc:
|
|
1123
|
-
mcity:
|
|
1124
|
-
mcountry:
|
|
1125
|
-
mstate:
|
|
1126
|
-
mzip:
|
|
1117
|
+
legal_name: "Sunshine Services, LLC",
|
|
1118
|
+
license: "2222222FFG",
|
|
1119
|
+
licstate: "CA",
|
|
1120
|
+
maddress: "123 Walnut Street",
|
|
1121
|
+
maddress_1: "STE 900",
|
|
1122
|
+
mcc: "7777",
|
|
1123
|
+
mcity: "Johnson City",
|
|
1124
|
+
mcountry: "US",
|
|
1125
|
+
mstate: "TN",
|
|
1126
|
+
mzip: "37615",
|
|
1127
1127
|
org_id: 123,
|
|
1128
1128
|
ownership: [{
|
|
1129
|
-
oaddress:
|
|
1130
|
-
ocity:
|
|
1131
|
-
ocountry:
|
|
1132
|
-
odriverstate:
|
|
1133
|
-
ostate:
|
|
1134
|
-
ownerdob:
|
|
1135
|
-
ownerdriver:
|
|
1136
|
-
owneremail:
|
|
1137
|
-
ownername:
|
|
1129
|
+
oaddress: "33 North St",
|
|
1130
|
+
ocity: "Any City",
|
|
1131
|
+
ocountry: "US",
|
|
1132
|
+
odriverstate: "CA",
|
|
1133
|
+
ostate: "CA",
|
|
1134
|
+
ownerdob: "01/01/1990",
|
|
1135
|
+
ownerdriver: "CA6677778",
|
|
1136
|
+
owneremail: "test@email.com",
|
|
1137
|
+
ownername: "John Smith",
|
|
1138
1138
|
ownerpercent: 100,
|
|
1139
|
-
ownerphone_1:
|
|
1140
|
-
ownerphone_2:
|
|
1141
|
-
ownerssn:
|
|
1142
|
-
ownertitle:
|
|
1143
|
-
ozip:
|
|
1139
|
+
ownerphone_1: "555888111",
|
|
1140
|
+
ownerphone_2: "555888111",
|
|
1141
|
+
ownerssn: "123456789",
|
|
1142
|
+
ownertitle: "CEO",
|
|
1143
|
+
ozip: "55555"
|
|
1144
1144
|
}],
|
|
1145
|
-
phonenumber:
|
|
1146
|
-
processing_region:
|
|
1147
|
-
recipient_email:
|
|
1145
|
+
phonenumber: "1234567890",
|
|
1146
|
+
processing_region: "US",
|
|
1147
|
+
recipient_email: "josephray@example.com",
|
|
1148
1148
|
recipient_email_notification: true,
|
|
1149
1149
|
resumable: true,
|
|
1150
1150
|
signer: {
|
|
1151
|
-
address:
|
|
1152
|
-
address_1:
|
|
1153
|
-
city:
|
|
1154
|
-
country:
|
|
1155
|
-
dob:
|
|
1156
|
-
email:
|
|
1157
|
-
name:
|
|
1158
|
-
phone:
|
|
1159
|
-
ssn:
|
|
1160
|
-
state:
|
|
1161
|
-
zip:
|
|
1151
|
+
address: "33 North St",
|
|
1152
|
+
address_1: "STE 900",
|
|
1153
|
+
city: "Bristol",
|
|
1154
|
+
country: "US",
|
|
1155
|
+
dob: "01/01/1976",
|
|
1156
|
+
email: "test@email.com",
|
|
1157
|
+
name: "John Smith",
|
|
1158
|
+
phone: "555888111",
|
|
1159
|
+
ssn: "123456789",
|
|
1160
|
+
state: "TN",
|
|
1161
|
+
zip: "55555",
|
|
1162
1162
|
pci_attestation: true,
|
|
1163
|
-
signed_document_reference:
|
|
1164
|
-
attestation_date:
|
|
1165
|
-
sign_date:
|
|
1163
|
+
signed_document_reference: "https://example.com/signed-document.pdf",
|
|
1164
|
+
attestation_date: "04/20/2025",
|
|
1165
|
+
sign_date: "04/20/2025",
|
|
1166
1166
|
additional_data: '{"deviceId":"499585-389fj484-3jcj8hj3","session":"fifji4-fiu443-fn4843","timeWithCompany":"6 Years"}'
|
|
1167
1167
|
},
|
|
1168
|
-
startdate:
|
|
1169
|
-
tax_fill_name:
|
|
1168
|
+
startdate: "01/01/1990",
|
|
1169
|
+
tax_fill_name: "Sunshine LLC",
|
|
1170
1170
|
template_id: 22,
|
|
1171
1171
|
ticketamt: 1000,
|
|
1172
|
-
website:
|
|
1173
|
-
when_charged:
|
|
1174
|
-
when_delivered:
|
|
1175
|
-
when_provided:
|
|
1176
|
-
when_refunded:
|
|
1177
|
-
)
|
|
1172
|
+
website: "www.example.com",
|
|
1173
|
+
when_charged: "When Service Provided",
|
|
1174
|
+
when_delivered: "Over 30 Days",
|
|
1175
|
+
when_provided: "30 Days or Less",
|
|
1176
|
+
when_refunded: "30 Days or Less"
|
|
1177
|
+
)
|
|
1178
1178
|
```
|
|
1179
1179
|
</dd>
|
|
1180
1180
|
</dl>
|
|
@@ -1236,7 +1236,7 @@ Deletes a boarding application by ID.
|
|
|
1236
1236
|
<dd>
|
|
1237
1237
|
|
|
1238
1238
|
```ruby
|
|
1239
|
-
client.boarding.delete_application(app_id: 352)
|
|
1239
|
+
client.boarding.delete_application(app_id: 352)
|
|
1240
1240
|
```
|
|
1241
1241
|
</dd>
|
|
1242
1242
|
</dl>
|
|
@@ -1298,7 +1298,7 @@ Retrieves the details for a boarding application by ID.
|
|
|
1298
1298
|
<dd>
|
|
1299
1299
|
|
|
1300
1300
|
```ruby
|
|
1301
|
-
client.boarding.get_application(app_id: 352)
|
|
1301
|
+
client.boarding.get_application(app_id: 352)
|
|
1302
1302
|
```
|
|
1303
1303
|
</dd>
|
|
1304
1304
|
</dl>
|
|
@@ -1361,10 +1361,10 @@ Gets a boarding application by authentication information. This endpoint require
|
|
|
1361
1361
|
|
|
1362
1362
|
```ruby
|
|
1363
1363
|
client.boarding.get_application_by_auth(
|
|
1364
|
-
x_id:
|
|
1365
|
-
email:
|
|
1366
|
-
reference_id:
|
|
1367
|
-
)
|
|
1364
|
+
x_id: "17E",
|
|
1365
|
+
email: "admin@email.com",
|
|
1366
|
+
reference_id: "n6UCd1f1ygG7"
|
|
1367
|
+
)
|
|
1368
1368
|
```
|
|
1369
1369
|
</dd>
|
|
1370
1370
|
</dl>
|
|
@@ -1442,7 +1442,7 @@ Retrieves details for a boarding link, by ID.
|
|
|
1442
1442
|
<dd>
|
|
1443
1443
|
|
|
1444
1444
|
```ruby
|
|
1445
|
-
client.boarding.get_by_id_link_application(boarding_link_id: 91)
|
|
1445
|
+
client.boarding.get_by_id_link_application(boarding_link_id: 91)
|
|
1446
1446
|
```
|
|
1447
1447
|
</dd>
|
|
1448
1448
|
</dl>
|
|
@@ -1504,7 +1504,7 @@ Get details for a boarding link using the boarding template ID. This endpoint re
|
|
|
1504
1504
|
<dd>
|
|
1505
1505
|
|
|
1506
1506
|
```ruby
|
|
1507
|
-
client.boarding.get_by_template_id_link_application(template_id: 80)
|
|
1507
|
+
client.boarding.get_by_template_id_link_application(template_id: 80)
|
|
1508
1508
|
```
|
|
1509
1509
|
</dd>
|
|
1510
1510
|
</dl>
|
|
@@ -1568,8 +1568,8 @@ Retrieves a link and the verification code used to log into an existing boarding
|
|
|
1568
1568
|
```ruby
|
|
1569
1569
|
client.boarding.get_external_application(
|
|
1570
1570
|
app_id: 352,
|
|
1571
|
-
mail_2:
|
|
1572
|
-
)
|
|
1571
|
+
mail_2: "mail2"
|
|
1572
|
+
)
|
|
1573
1573
|
```
|
|
1574
1574
|
</dd>
|
|
1575
1575
|
</dl>
|
|
@@ -1647,7 +1647,7 @@ Retrieves the details for a boarding link, by reference name. This endpoint requ
|
|
|
1647
1647
|
<dd>
|
|
1648
1648
|
|
|
1649
1649
|
```ruby
|
|
1650
|
-
client.boarding.get_link_application(boarding_link_reference:
|
|
1650
|
+
client.boarding.get_link_application(boarding_link_reference: "myorgaccountname-00091")
|
|
1651
1651
|
```
|
|
1652
1652
|
</dd>
|
|
1653
1653
|
</dl>
|
|
@@ -1713,8 +1713,8 @@ client.boarding.list_applications(
|
|
|
1713
1713
|
org_id: 123,
|
|
1714
1714
|
from_record: 251,
|
|
1715
1715
|
limit_record: 0,
|
|
1716
|
-
sort_by:
|
|
1717
|
-
)
|
|
1716
|
+
sort_by: "desc(field_name)"
|
|
1717
|
+
)
|
|
1718
1718
|
```
|
|
1719
1719
|
</dd>
|
|
1720
1720
|
</dl>
|
|
@@ -1856,8 +1856,8 @@ client.boarding.list_boarding_links(
|
|
|
1856
1856
|
org_id: 123,
|
|
1857
1857
|
from_record: 251,
|
|
1858
1858
|
limit_record: 0,
|
|
1859
|
-
sort_by:
|
|
1860
|
-
)
|
|
1859
|
+
sort_by: "desc(field_name)"
|
|
1860
|
+
)
|
|
1861
1861
|
```
|
|
1862
1862
|
</dd>
|
|
1863
1863
|
</dl>
|
|
@@ -1983,7 +1983,7 @@ Updates a boarding application by ID. This endpoint requires an application API
|
|
|
1983
1983
|
<dd>
|
|
1984
1984
|
|
|
1985
1985
|
```ruby
|
|
1986
|
-
client.boarding.update_application(app_id: 352)
|
|
1986
|
+
client.boarding.update_application(app_id: 352)
|
|
1987
1987
|
```
|
|
1988
1988
|
</dd>
|
|
1989
1989
|
</dl>
|
|
@@ -2056,8 +2056,8 @@ Add a response to a chargeback or ACH return.
|
|
|
2056
2056
|
```ruby
|
|
2057
2057
|
client.charge_backs.add_response(
|
|
2058
2058
|
id: 1000000,
|
|
2059
|
-
idempotency_key:
|
|
2060
|
-
)
|
|
2059
|
+
idempotency_key: "6B29FC40-CA47-1067-B31D-00DD010662DA"
|
|
2060
|
+
)
|
|
2061
2061
|
```
|
|
2062
2062
|
</dd>
|
|
2063
2063
|
</dl>
|
|
@@ -2159,7 +2159,7 @@ Retrieves a chargeback record and its details.
|
|
|
2159
2159
|
<dd>
|
|
2160
2160
|
|
|
2161
2161
|
```ruby
|
|
2162
|
-
client.charge_backs.get_chargeback(id: 1000000)
|
|
2162
|
+
client.charge_backs.get_chargeback(id: 1000000)
|
|
2163
2163
|
```
|
|
2164
2164
|
</dd>
|
|
2165
2165
|
</dl>
|
|
@@ -2223,8 +2223,8 @@ Retrieves a chargeback attachment file by its file name.
|
|
|
2223
2223
|
```ruby
|
|
2224
2224
|
client.charge_backs.get_chargeback_attachment(
|
|
2225
2225
|
id: 1000000,
|
|
2226
|
-
file_name:
|
|
2227
|
-
)
|
|
2226
|
+
file_name: "fileName"
|
|
2227
|
+
)
|
|
2228
2228
|
```
|
|
2229
2229
|
</dd>
|
|
2230
2230
|
</dl>
|
|
@@ -2296,11 +2296,11 @@ Captures a check for Remote Deposit Capture (RDC) using the provided check image
|
|
|
2296
2296
|
|
|
2297
2297
|
```ruby
|
|
2298
2298
|
client.check_capture.check_processing(
|
|
2299
|
-
entry_point:
|
|
2300
|
-
front_image:
|
|
2301
|
-
rear_image:
|
|
2299
|
+
entry_point: "47abcfea12",
|
|
2300
|
+
front_image: "/9j/4AAQSkZJRgABAQEASABIAAD...",
|
|
2301
|
+
rear_image: "/9j/4AAQSkZJRgABAQEASABIAAD...",
|
|
2302
2302
|
check_amount: 12550
|
|
2303
|
-
)
|
|
2303
|
+
)
|
|
2304
2304
|
```
|
|
2305
2305
|
</dd>
|
|
2306
2306
|
</dl>
|
|
@@ -2388,10 +2388,10 @@ Register a cloud device to an entrypoint. See [Devices Quickstart](/developers/d
|
|
|
2388
2388
|
|
|
2389
2389
|
```ruby
|
|
2390
2390
|
client.cloud.add_device(
|
|
2391
|
-
entry:
|
|
2392
|
-
registration_code:
|
|
2393
|
-
description:
|
|
2394
|
-
)
|
|
2391
|
+
entry: "8cfec329267",
|
|
2392
|
+
registration_code: "YS7DS5",
|
|
2393
|
+
description: "Front Desk POS"
|
|
2394
|
+
)
|
|
2395
2395
|
```
|
|
2396
2396
|
</dd>
|
|
2397
2397
|
</dl>
|
|
@@ -2484,9 +2484,9 @@ Retrieve the registration history for a device.
|
|
|
2484
2484
|
|
|
2485
2485
|
```ruby
|
|
2486
2486
|
client.cloud.history_device(
|
|
2487
|
-
device_id:
|
|
2488
|
-
entry:
|
|
2489
|
-
)
|
|
2487
|
+
device_id: "WXGDWB",
|
|
2488
|
+
entry: "8cfec329267"
|
|
2489
|
+
)
|
|
2490
2490
|
```
|
|
2491
2491
|
</dd>
|
|
2492
2492
|
</dl>
|
|
@@ -2556,7 +2556,7 @@ Get a list of cloud devices registered to an entrypoint.
|
|
|
2556
2556
|
<dd>
|
|
2557
2557
|
|
|
2558
2558
|
```ruby
|
|
2559
|
-
client.cloud.list_device(entry:
|
|
2559
|
+
client.cloud.list_device(entry: "8cfec329267")
|
|
2560
2560
|
```
|
|
2561
2561
|
</dd>
|
|
2562
2562
|
</dl>
|
|
@@ -2627,9 +2627,9 @@ Remove a cloud device from an entrypoint.
|
|
|
2627
2627
|
|
|
2628
2628
|
```ruby
|
|
2629
2629
|
client.cloud.remove_device(
|
|
2630
|
-
device_id:
|
|
2631
|
-
entry:
|
|
2632
|
-
)
|
|
2630
|
+
device_id: "6c361c7d-674c-44cc-b790-382b75d1xxx",
|
|
2631
|
+
entry: "8cfec329267"
|
|
2632
|
+
)
|
|
2633
2633
|
```
|
|
2634
2634
|
</dd>
|
|
2635
2635
|
</dl>
|
|
@@ -2702,19 +2702,19 @@ If you don't include an identifier, the record is rejected.
|
|
|
2702
2702
|
|
|
2703
2703
|
```ruby
|
|
2704
2704
|
client.customer.add_customer(
|
|
2705
|
-
entry:
|
|
2706
|
-
customer_number:
|
|
2707
|
-
firstname:
|
|
2708
|
-
lastname:
|
|
2709
|
-
email:
|
|
2705
|
+
entry: "8cfec329267",
|
|
2706
|
+
customer_number: "12356ACB",
|
|
2707
|
+
firstname: "Irene",
|
|
2708
|
+
lastname: "Canizales",
|
|
2709
|
+
email: "irene@canizalesconcrete.com",
|
|
2710
2710
|
address_1: "123 Bishop's Trail",
|
|
2711
|
-
city:
|
|
2712
|
-
state:
|
|
2713
|
-
zip:
|
|
2714
|
-
country:
|
|
2711
|
+
city: "Mountain City",
|
|
2712
|
+
state: "TN",
|
|
2713
|
+
zip: "37612",
|
|
2714
|
+
country: "US",
|
|
2715
2715
|
time_zone: -5,
|
|
2716
|
-
identifier_fields: [
|
|
2717
|
-
)
|
|
2716
|
+
identifier_fields: ["email"]
|
|
2717
|
+
)
|
|
2718
2718
|
```
|
|
2719
2719
|
</dd>
|
|
2720
2720
|
</dl>
|
|
@@ -2808,7 +2808,7 @@ Delete a customer record.
|
|
|
2808
2808
|
<dd>
|
|
2809
2809
|
|
|
2810
2810
|
```ruby
|
|
2811
|
-
client.customer.delete_customer(customer_id: 998)
|
|
2811
|
+
client.customer.delete_customer(customer_id: 998)
|
|
2812
2812
|
```
|
|
2813
2813
|
</dd>
|
|
2814
2814
|
</dl>
|
|
@@ -2870,7 +2870,7 @@ Retrieves a customer's record and details.
|
|
|
2870
2870
|
<dd>
|
|
2871
2871
|
|
|
2872
2872
|
```ruby
|
|
2873
|
-
client.customer.get_customer(customer_id: 998)
|
|
2873
|
+
client.customer.get_customer(customer_id: 998)
|
|
2874
2874
|
```
|
|
2875
2875
|
</dd>
|
|
2876
2876
|
</dl>
|
|
@@ -2934,8 +2934,8 @@ Links a customer to a transaction by ID.
|
|
|
2934
2934
|
```ruby
|
|
2935
2935
|
client.customer.link_customer_transaction(
|
|
2936
2936
|
customer_id: 998,
|
|
2937
|
-
trans_id:
|
|
2938
|
-
)
|
|
2937
|
+
trans_id: "45-as456777hhhhhhhhhh77777777-324"
|
|
2938
|
+
)
|
|
2939
2939
|
```
|
|
2940
2940
|
</dd>
|
|
2941
2941
|
</dl>
|
|
@@ -3005,7 +3005,7 @@ Sends the consent opt-in email to the customer email address in the customer rec
|
|
|
3005
3005
|
<dd>
|
|
3006
3006
|
|
|
3007
3007
|
```ruby
|
|
3008
|
-
client.customer.request_consent(customer_id: 998)
|
|
3008
|
+
client.customer.request_consent(customer_id: 998)
|
|
3009
3009
|
```
|
|
3010
3010
|
</dd>
|
|
3011
3011
|
</dl>
|
|
@@ -3069,14 +3069,14 @@ Update a customer record. Include only the fields you want to change.
|
|
|
3069
3069
|
```ruby
|
|
3070
3070
|
client.customer.update_customer(
|
|
3071
3071
|
customer_id: 998,
|
|
3072
|
-
firstname:
|
|
3073
|
-
lastname:
|
|
3072
|
+
firstname: "Irene",
|
|
3073
|
+
lastname: "Canizales",
|
|
3074
3074
|
address_1: "145 Bishop's Trail",
|
|
3075
|
-
city:
|
|
3076
|
-
state:
|
|
3077
|
-
zip:
|
|
3078
|
-
country:
|
|
3079
|
-
)
|
|
3075
|
+
city: "Mountain City",
|
|
3076
|
+
state: "TN",
|
|
3077
|
+
zip: "37612",
|
|
3078
|
+
country: "US"
|
|
3079
|
+
)
|
|
3080
3080
|
```
|
|
3081
3081
|
</dd>
|
|
3082
3082
|
</dl>
|
|
@@ -3148,12 +3148,12 @@ Export a list of boarding applications for an organization. Use filters to limit
|
|
|
3148
3148
|
|
|
3149
3149
|
```ruby
|
|
3150
3150
|
client.export.export_applications(
|
|
3151
|
-
format:
|
|
3151
|
+
format: "csv",
|
|
3152
3152
|
org_id: 123,
|
|
3153
|
-
columns_export:
|
|
3153
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
3154
3154
|
from_record: 251,
|
|
3155
3155
|
limit_record: 1000
|
|
3156
|
-
)
|
|
3156
|
+
)
|
|
3157
3157
|
```
|
|
3158
3158
|
</dd>
|
|
3159
3159
|
</dl>
|
|
@@ -3309,12 +3309,12 @@ This endpoint is deprecated. Export batch details for a paypoint. Use filters to
|
|
|
3309
3309
|
|
|
3310
3310
|
```ruby
|
|
3311
3311
|
client.export.export_batch_details(
|
|
3312
|
-
entry:
|
|
3313
|
-
format:
|
|
3314
|
-
columns_export:
|
|
3312
|
+
entry: "8cfec329267",
|
|
3313
|
+
format: "csv",
|
|
3314
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
3315
3315
|
from_record: 251,
|
|
3316
3316
|
limit_record: 1000
|
|
3317
|
-
)
|
|
3317
|
+
)
|
|
3318
3318
|
```
|
|
3319
3319
|
</dd>
|
|
3320
3320
|
</dl>
|
|
@@ -3481,12 +3481,12 @@ This endpoint is deprecated. Export batch details for an organization. Use filte
|
|
|
3481
3481
|
|
|
3482
3482
|
```ruby
|
|
3483
3483
|
client.export.export_batch_details_org(
|
|
3484
|
-
format:
|
|
3484
|
+
format: "csv",
|
|
3485
3485
|
org_id: 123,
|
|
3486
|
-
columns_export:
|
|
3486
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
3487
3487
|
from_record: 251,
|
|
3488
3488
|
limit_record: 1000
|
|
3489
|
-
)
|
|
3489
|
+
)
|
|
3490
3490
|
```
|
|
3491
3491
|
</dd>
|
|
3492
3492
|
</dl>
|
|
@@ -3653,12 +3653,12 @@ Export a list of batches for an entrypoint. Use filters to limit results.
|
|
|
3653
3653
|
|
|
3654
3654
|
```ruby
|
|
3655
3655
|
client.export.export_batches(
|
|
3656
|
-
entry:
|
|
3657
|
-
format:
|
|
3658
|
-
columns_export:
|
|
3656
|
+
entry: "8cfec329267",
|
|
3657
|
+
format: "csv",
|
|
3658
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
3659
3659
|
from_record: 251,
|
|
3660
3660
|
limit_record: 1000
|
|
3661
|
-
)
|
|
3661
|
+
)
|
|
3662
3662
|
```
|
|
3663
3663
|
</dd>
|
|
3664
3664
|
</dl>
|
|
@@ -3815,12 +3815,12 @@ Export a list of batches for an organization. Use filters to limit results.
|
|
|
3815
3815
|
|
|
3816
3816
|
```ruby
|
|
3817
3817
|
client.export.export_batches_org(
|
|
3818
|
-
format:
|
|
3818
|
+
format: "csv",
|
|
3819
3819
|
org_id: 123,
|
|
3820
|
-
columns_export:
|
|
3820
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
3821
3821
|
from_record: 251,
|
|
3822
3822
|
limit_record: 1000
|
|
3823
|
-
)
|
|
3823
|
+
)
|
|
3824
3824
|
```
|
|
3825
3825
|
</dd>
|
|
3826
3826
|
</dl>
|
|
@@ -3975,12 +3975,12 @@ Export a list of money out batches for a paypoint. Use filters to limit results.
|
|
|
3975
3975
|
|
|
3976
3976
|
```ruby
|
|
3977
3977
|
client.export.export_batches_out(
|
|
3978
|
-
entry:
|
|
3979
|
-
format:
|
|
3980
|
-
columns_export:
|
|
3978
|
+
entry: "8cfec329267",
|
|
3979
|
+
format: "csv",
|
|
3980
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
3981
3981
|
from_record: 251,
|
|
3982
3982
|
limit_record: 1000
|
|
3983
|
-
)
|
|
3983
|
+
)
|
|
3984
3984
|
```
|
|
3985
3985
|
</dd>
|
|
3986
3986
|
</dl>
|
|
@@ -4117,12 +4117,12 @@ Export a list of money out batches for an organization. Use filters to limit res
|
|
|
4117
4117
|
|
|
4118
4118
|
```ruby
|
|
4119
4119
|
client.export.export_batches_out_org(
|
|
4120
|
-
format:
|
|
4120
|
+
format: "csv",
|
|
4121
4121
|
org_id: 123,
|
|
4122
|
-
columns_export:
|
|
4122
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
4123
4123
|
from_record: 251,
|
|
4124
4124
|
limit_record: 1000
|
|
4125
|
-
)
|
|
4125
|
+
)
|
|
4126
4126
|
```
|
|
4127
4127
|
</dd>
|
|
4128
4128
|
</dl>
|
|
@@ -4259,12 +4259,12 @@ Export a list of bills for an entrypoint. Use filters to limit results.
|
|
|
4259
4259
|
|
|
4260
4260
|
```ruby
|
|
4261
4261
|
client.export.export_bills(
|
|
4262
|
-
entry:
|
|
4263
|
-
format:
|
|
4264
|
-
columns_export:
|
|
4262
|
+
entry: "8cfec329267",
|
|
4263
|
+
format: "csv",
|
|
4264
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
4265
4265
|
from_record: 251,
|
|
4266
4266
|
limit_record: 1000
|
|
4267
|
-
)
|
|
4267
|
+
)
|
|
4268
4268
|
```
|
|
4269
4269
|
</dd>
|
|
4270
4270
|
</dl>
|
|
@@ -4419,12 +4419,12 @@ Export a list of bills for an organization. Use filters to limit results.
|
|
|
4419
4419
|
|
|
4420
4420
|
```ruby
|
|
4421
4421
|
client.export.export_bills_org(
|
|
4422
|
-
format:
|
|
4422
|
+
format: "csv",
|
|
4423
4423
|
org_id: 123,
|
|
4424
|
-
columns_export:
|
|
4424
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
4425
4425
|
from_record: 251,
|
|
4426
4426
|
limit_record: 1000
|
|
4427
|
-
)
|
|
4427
|
+
)
|
|
4428
4428
|
```
|
|
4429
4429
|
</dd>
|
|
4430
4430
|
</dl>
|
|
@@ -4579,12 +4579,12 @@ Export a list of chargebacks and ACH returns for an entrypoint. Use filters to l
|
|
|
4579
4579
|
|
|
4580
4580
|
```ruby
|
|
4581
4581
|
client.export.export_chargebacks(
|
|
4582
|
-
entry:
|
|
4583
|
-
format:
|
|
4584
|
-
columns_export:
|
|
4582
|
+
entry: "8cfec329267",
|
|
4583
|
+
format: "csv",
|
|
4584
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
4585
4585
|
from_record: 251,
|
|
4586
4586
|
limit_record: 1000
|
|
4587
|
-
)
|
|
4587
|
+
)
|
|
4588
4588
|
```
|
|
4589
4589
|
</dd>
|
|
4590
4590
|
</dl>
|
|
@@ -4760,12 +4760,12 @@ Export a list of chargebacks and ACH returns for an organization. Use filters to
|
|
|
4760
4760
|
|
|
4761
4761
|
```ruby
|
|
4762
4762
|
client.export.export_chargebacks_org(
|
|
4763
|
-
format:
|
|
4763
|
+
format: "csv",
|
|
4764
4764
|
org_id: 123,
|
|
4765
|
-
columns_export:
|
|
4765
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
4766
4766
|
from_record: 251,
|
|
4767
4767
|
limit_record: 1000
|
|
4768
|
-
)
|
|
4768
|
+
)
|
|
4769
4769
|
```
|
|
4770
4770
|
</dd>
|
|
4771
4771
|
</dl>
|
|
@@ -4941,12 +4941,12 @@ Export a list of customers for an entrypoint. Use filters to limit results.
|
|
|
4941
4941
|
|
|
4942
4942
|
```ruby
|
|
4943
4943
|
client.export.export_customers(
|
|
4944
|
-
entry:
|
|
4945
|
-
format:
|
|
4946
|
-
columns_export:
|
|
4944
|
+
entry: "8cfec329267",
|
|
4945
|
+
format: "csv",
|
|
4946
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
4947
4947
|
from_record: 251,
|
|
4948
4948
|
limit_record: 1000
|
|
4949
|
-
)
|
|
4949
|
+
)
|
|
4950
4950
|
```
|
|
4951
4951
|
</dd>
|
|
4952
4952
|
</dl>
|
|
@@ -5115,12 +5115,12 @@ Exports a list of customers for an organization. Use filters to limit results.
|
|
|
5115
5115
|
|
|
5116
5116
|
```ruby
|
|
5117
5117
|
client.export.export_customers_org(
|
|
5118
|
-
format:
|
|
5118
|
+
format: "csv",
|
|
5119
5119
|
org_id: 123,
|
|
5120
|
-
columns_export:
|
|
5120
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
5121
5121
|
from_record: 251,
|
|
5122
5122
|
limit_record: 1000
|
|
5123
|
-
)
|
|
5123
|
+
)
|
|
5124
5124
|
```
|
|
5125
5125
|
</dd>
|
|
5126
5126
|
</dl>
|
|
@@ -5289,12 +5289,12 @@ Export list of invoices for an entrypoint. Use filters to limit results.
|
|
|
5289
5289
|
|
|
5290
5290
|
```ruby
|
|
5291
5291
|
client.export.export_invoices(
|
|
5292
|
-
entry:
|
|
5293
|
-
format:
|
|
5294
|
-
columns_export:
|
|
5292
|
+
entry: "8cfec329267",
|
|
5293
|
+
format: "csv",
|
|
5294
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
5295
5295
|
from_record: 251,
|
|
5296
5296
|
limit_record: 1000
|
|
5297
|
-
)
|
|
5297
|
+
)
|
|
5298
5298
|
```
|
|
5299
5299
|
</dd>
|
|
5300
5300
|
</dl>
|
|
@@ -5473,12 +5473,12 @@ Export a list of invoices for an organization. Use filters to limit results.
|
|
|
5473
5473
|
|
|
5474
5474
|
```ruby
|
|
5475
5475
|
client.export.export_invoices_org(
|
|
5476
|
-
format:
|
|
5476
|
+
format: "csv",
|
|
5477
5477
|
org_id: 123,
|
|
5478
|
-
columns_export:
|
|
5478
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
5479
5479
|
from_record: 251,
|
|
5480
5480
|
limit_record: 1000
|
|
5481
|
-
)
|
|
5481
|
+
)
|
|
5482
5482
|
```
|
|
5483
5483
|
</dd>
|
|
5484
5484
|
</dl>
|
|
@@ -5657,12 +5657,12 @@ Export a list of child organizations (suborganizations) for a parent organizatio
|
|
|
5657
5657
|
|
|
5658
5658
|
```ruby
|
|
5659
5659
|
client.export.export_organizations(
|
|
5660
|
-
format:
|
|
5660
|
+
format: "csv",
|
|
5661
5661
|
org_id: 123,
|
|
5662
|
-
columns_export:
|
|
5662
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
5663
5663
|
from_record: 251,
|
|
5664
5664
|
limit_record: 1000
|
|
5665
|
-
)
|
|
5665
|
+
)
|
|
5666
5666
|
```
|
|
5667
5667
|
</dd>
|
|
5668
5668
|
</dl>
|
|
@@ -5816,12 +5816,12 @@ Export a list of payouts and their statuses for an entrypoint. Use filters to li
|
|
|
5816
5816
|
|
|
5817
5817
|
```ruby
|
|
5818
5818
|
client.export.export_payout(
|
|
5819
|
-
entry:
|
|
5820
|
-
format:
|
|
5821
|
-
columns_export:
|
|
5819
|
+
entry: "8cfec329267",
|
|
5820
|
+
format: "csv",
|
|
5821
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
5822
5822
|
from_record: 251,
|
|
5823
5823
|
limit_record: 1000
|
|
5824
|
-
)
|
|
5824
|
+
)
|
|
5825
5825
|
```
|
|
5826
5826
|
</dd>
|
|
5827
5827
|
</dl>
|
|
@@ -5974,12 +5974,12 @@ Export a list of payouts and their details for an organization. Use filters to l
|
|
|
5974
5974
|
|
|
5975
5975
|
```ruby
|
|
5976
5976
|
client.export.export_payout_org(
|
|
5977
|
-
format:
|
|
5977
|
+
format: "csv",
|
|
5978
5978
|
org_id: 123,
|
|
5979
|
-
columns_export:
|
|
5979
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
5980
5980
|
from_record: 251,
|
|
5981
5981
|
limit_record: 1000
|
|
5982
|
-
)
|
|
5982
|
+
)
|
|
5983
5983
|
```
|
|
5984
5984
|
</dd>
|
|
5985
5985
|
</dl>
|
|
@@ -6132,12 +6132,12 @@ Export a list of paypoints in an organization. Use filters to limit results.
|
|
|
6132
6132
|
|
|
6133
6133
|
```ruby
|
|
6134
6134
|
client.export.export_paypoints(
|
|
6135
|
-
format:
|
|
6135
|
+
format: "csv",
|
|
6136
6136
|
org_id: 123,
|
|
6137
|
-
columns_export:
|
|
6137
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
6138
6138
|
from_record: 251,
|
|
6139
6139
|
limit_record: 1000
|
|
6140
|
-
)
|
|
6140
|
+
)
|
|
6141
6141
|
```
|
|
6142
6142
|
</dd>
|
|
6143
6143
|
</dl>
|
|
@@ -6292,12 +6292,12 @@ Export a list of settled transactions for an entrypoint. Use filters to limit re
|
|
|
6292
6292
|
|
|
6293
6293
|
```ruby
|
|
6294
6294
|
client.export.export_settlements(
|
|
6295
|
-
entry:
|
|
6296
|
-
format:
|
|
6297
|
-
columns_export:
|
|
6295
|
+
entry: "8cfec329267",
|
|
6296
|
+
format: "csv",
|
|
6297
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
6298
6298
|
from_record: 251,
|
|
6299
6299
|
limit_record: 1000
|
|
6300
|
-
)
|
|
6300
|
+
)
|
|
6301
6301
|
```
|
|
6302
6302
|
</dd>
|
|
6303
6303
|
</dl>
|
|
@@ -6472,12 +6472,12 @@ Export a list of settled transactions for an organization. Use filters to limit
|
|
|
6472
6472
|
|
|
6473
6473
|
```ruby
|
|
6474
6474
|
client.export.export_settlements_org(
|
|
6475
|
-
format:
|
|
6475
|
+
format: "csv",
|
|
6476
6476
|
org_id: 123,
|
|
6477
|
-
columns_export:
|
|
6477
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
6478
6478
|
from_record: 251,
|
|
6479
6479
|
limit_record: 1000
|
|
6480
|
-
)
|
|
6480
|
+
)
|
|
6481
6481
|
```
|
|
6482
6482
|
</dd>
|
|
6483
6483
|
</dl>
|
|
@@ -6652,12 +6652,12 @@ Export a list of subscriptions for an entrypoint. Use filters to limit results.
|
|
|
6652
6652
|
|
|
6653
6653
|
```ruby
|
|
6654
6654
|
client.export.export_subscriptions(
|
|
6655
|
-
entry:
|
|
6656
|
-
format:
|
|
6657
|
-
columns_export:
|
|
6655
|
+
entry: "8cfec329267",
|
|
6656
|
+
format: "csv",
|
|
6657
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
6658
6658
|
from_record: 251,
|
|
6659
6659
|
limit_record: 1000
|
|
6660
|
-
)
|
|
6660
|
+
)
|
|
6661
6661
|
```
|
|
6662
6662
|
</dd>
|
|
6663
6663
|
</dl>
|
|
@@ -6834,12 +6834,12 @@ Export a list of subscriptions for an organization. Use filters to limit results
|
|
|
6834
6834
|
|
|
6835
6835
|
```ruby
|
|
6836
6836
|
client.export.export_subscriptions_org(
|
|
6837
|
-
format:
|
|
6837
|
+
format: "csv",
|
|
6838
6838
|
org_id: 123,
|
|
6839
|
-
columns_export:
|
|
6839
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
6840
6840
|
from_record: 251,
|
|
6841
6841
|
limit_record: 1000
|
|
6842
|
-
)
|
|
6842
|
+
)
|
|
6843
6843
|
```
|
|
6844
6844
|
</dd>
|
|
6845
6845
|
</dl>
|
|
@@ -7016,12 +7016,12 @@ Export a list of transactions for an entrypoint in a file in XLXS or CSV format.
|
|
|
7016
7016
|
|
|
7017
7017
|
```ruby
|
|
7018
7018
|
client.export.export_transactions(
|
|
7019
|
-
entry:
|
|
7020
|
-
format:
|
|
7021
|
-
columns_export:
|
|
7019
|
+
entry: "8cfec329267",
|
|
7020
|
+
format: "csv",
|
|
7021
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
7022
7022
|
from_record: 251,
|
|
7023
7023
|
limit_record: 1000
|
|
7024
|
-
)
|
|
7024
|
+
)
|
|
7025
7025
|
```
|
|
7026
7026
|
</dd>
|
|
7027
7027
|
</dl>
|
|
@@ -7202,12 +7202,12 @@ Export a list of transactions for an org in a file in XLSX or CSV format. Use fi
|
|
|
7202
7202
|
|
|
7203
7203
|
```ruby
|
|
7204
7204
|
client.export.export_transactions_org(
|
|
7205
|
-
format:
|
|
7205
|
+
format: "csv",
|
|
7206
7206
|
org_id: 123,
|
|
7207
|
-
columns_export:
|
|
7207
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
7208
7208
|
from_record: 251,
|
|
7209
7209
|
limit_record: 1000
|
|
7210
|
-
)
|
|
7210
|
+
)
|
|
7211
7211
|
```
|
|
7212
7212
|
</dd>
|
|
7213
7213
|
</dl>
|
|
@@ -7388,14 +7388,14 @@ Export a list of transfer details for an entrypoint. Use filters to limit result
|
|
|
7388
7388
|
|
|
7389
7389
|
```ruby
|
|
7390
7390
|
client.export.export_transfer_details(
|
|
7391
|
-
entry:
|
|
7392
|
-
format:
|
|
7391
|
+
entry: "8cfec329267",
|
|
7392
|
+
format: "csv",
|
|
7393
7393
|
transfer_id: 1000000,
|
|
7394
|
-
columns_export:
|
|
7394
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
7395
7395
|
from_record: 251,
|
|
7396
7396
|
limit_record: 1000,
|
|
7397
|
-
sort_by:
|
|
7398
|
-
)
|
|
7397
|
+
sort_by: "desc(field_name)"
|
|
7398
|
+
)
|
|
7399
7399
|
```
|
|
7400
7400
|
</dd>
|
|
7401
7401
|
</dl>
|
|
@@ -7556,12 +7556,12 @@ Get a list of transfers for an entrypoint. Use filters to limit results.
|
|
|
7556
7556
|
|
|
7557
7557
|
```ruby
|
|
7558
7558
|
client.export.export_transfers(
|
|
7559
|
-
entry:
|
|
7560
|
-
columns_export:
|
|
7559
|
+
entry: "8cfec329267",
|
|
7560
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
7561
7561
|
from_record: 251,
|
|
7562
7562
|
limit_record: 1000,
|
|
7563
|
-
sort_by:
|
|
7564
|
-
)
|
|
7563
|
+
sort_by: "desc(field_name)"
|
|
7564
|
+
)
|
|
7565
7565
|
```
|
|
7566
7566
|
</dd>
|
|
7567
7567
|
</dl>
|
|
@@ -7707,12 +7707,12 @@ Export a list of vendors for an entrypoint. Use filters to limit results.
|
|
|
7707
7707
|
|
|
7708
7708
|
```ruby
|
|
7709
7709
|
client.export.export_vendors(
|
|
7710
|
-
entry:
|
|
7711
|
-
format:
|
|
7712
|
-
columns_export:
|
|
7710
|
+
entry: "8cfec329267",
|
|
7711
|
+
format: "csv",
|
|
7712
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
7713
7713
|
from_record: 251,
|
|
7714
7714
|
limit_record: 1000
|
|
7715
|
-
)
|
|
7715
|
+
)
|
|
7716
7716
|
```
|
|
7717
7717
|
</dd>
|
|
7718
7718
|
</dl>
|
|
@@ -7871,12 +7871,12 @@ Export a list of vendors for an organization. Use filters to limit results.
|
|
|
7871
7871
|
|
|
7872
7872
|
```ruby
|
|
7873
7873
|
client.export.export_vendors_org(
|
|
7874
|
-
format:
|
|
7874
|
+
format: "csv",
|
|
7875
7875
|
org_id: 123,
|
|
7876
|
-
columns_export:
|
|
7876
|
+
columns_export: "BatchDate:Batch_Date,PaypointName:Legal_name",
|
|
7877
7877
|
from_record: 251,
|
|
7878
7878
|
limit_record: 1000
|
|
7879
|
-
)
|
|
7879
|
+
)
|
|
7880
7880
|
```
|
|
7881
7881
|
</dd>
|
|
7882
7882
|
</dl>
|
|
@@ -8036,9 +8036,9 @@ Loads all of a payment page's details including `pageIdentifier` and `validation
|
|
|
8036
8036
|
|
|
8037
8037
|
```ruby
|
|
8038
8038
|
client.hosted_payment_pages.load_page(
|
|
8039
|
-
entry:
|
|
8040
|
-
subdomain:
|
|
8041
|
-
)
|
|
8039
|
+
entry: "8cfec329267",
|
|
8040
|
+
subdomain: "pay-your-fees-1"
|
|
8041
|
+
)
|
|
8042
8042
|
```
|
|
8043
8043
|
</dd>
|
|
8044
8044
|
</dl>
|
|
@@ -8111,9 +8111,9 @@ Note: this operation doesn't create a new paypoint, just a payment page for an e
|
|
|
8111
8111
|
|
|
8112
8112
|
```ruby
|
|
8113
8113
|
client.hosted_payment_pages.new_page(
|
|
8114
|
-
entry:
|
|
8115
|
-
idempotency_key:
|
|
8116
|
-
)
|
|
8114
|
+
entry: "8cfec329267",
|
|
8115
|
+
idempotency_key: "6B29FC40-CA47-1067-B31D-00DD010662DA"
|
|
8116
|
+
)
|
|
8117
8117
|
```
|
|
8118
8118
|
</dd>
|
|
8119
8119
|
</dl>
|
|
@@ -8192,9 +8192,9 @@ Updates a payment page in a paypoint.
|
|
|
8192
8192
|
|
|
8193
8193
|
```ruby
|
|
8194
8194
|
client.hosted_payment_pages.save_page(
|
|
8195
|
-
entry:
|
|
8196
|
-
subdomain:
|
|
8197
|
-
)
|
|
8195
|
+
entry: "8cfec329267",
|
|
8196
|
+
subdomain: "pay-your-fees-1"
|
|
8197
|
+
)
|
|
8198
8198
|
```
|
|
8199
8199
|
</dd>
|
|
8200
8200
|
</dl>
|
|
@@ -8273,7 +8273,7 @@ Import a list of bills from a CSV file. See the [Import Guide](/developers/devel
|
|
|
8273
8273
|
<dd>
|
|
8274
8274
|
|
|
8275
8275
|
```ruby
|
|
8276
|
-
client.import.import_bills(entry:
|
|
8276
|
+
client.import.import_bills(entry: "8cfec329267")
|
|
8277
8277
|
```
|
|
8278
8278
|
</dd>
|
|
8279
8279
|
</dl>
|
|
@@ -8335,7 +8335,7 @@ Import a list of customers from a CSV file. See the [Import Guide](/developers/d
|
|
|
8335
8335
|
<dd>
|
|
8336
8336
|
|
|
8337
8337
|
```ruby
|
|
8338
|
-
client.import.import_customer(entry:
|
|
8338
|
+
client.import.import_customer(entry: "8cfec329267")
|
|
8339
8339
|
```
|
|
8340
8340
|
</dd>
|
|
8341
8341
|
</dl>
|
|
@@ -8405,7 +8405,7 @@ Import a list of vendors from a CSV file. See the [Import Guide](/developers/dev
|
|
|
8405
8405
|
<dd>
|
|
8406
8406
|
|
|
8407
8407
|
```ruby
|
|
8408
|
-
client.import.import_vendor(entry:
|
|
8408
|
+
client.import.import_vendor(entry: "8cfec329267")
|
|
8409
8409
|
```
|
|
8410
8410
|
</dd>
|
|
8411
8411
|
</dl>
|
|
@@ -8469,36 +8469,36 @@ Creates an invoice in an entrypoint.
|
|
|
8469
8469
|
|
|
8470
8470
|
```ruby
|
|
8471
8471
|
client.invoice.add_invoice(
|
|
8472
|
-
entry:
|
|
8472
|
+
entry: "8cfec329267",
|
|
8473
8473
|
customer_data: {
|
|
8474
|
-
first_name:
|
|
8475
|
-
last_name:
|
|
8476
|
-
customer_number:
|
|
8474
|
+
first_name: "Tamara",
|
|
8475
|
+
last_name: "Bagratoni",
|
|
8476
|
+
customer_number: "3"
|
|
8477
8477
|
},
|
|
8478
8478
|
invoice_data: {
|
|
8479
8479
|
items: [{
|
|
8480
|
-
item_product_name:
|
|
8481
|
-
item_description:
|
|
8480
|
+
item_product_name: "Adventure Consult",
|
|
8481
|
+
item_description: "Consultation for Georgian tours",
|
|
8482
8482
|
item_cost: 100,
|
|
8483
8483
|
item_qty: 1,
|
|
8484
8484
|
item_mode: 1,
|
|
8485
8485
|
item_total_amount: 1
|
|
8486
8486
|
}, {
|
|
8487
|
-
item_product_name:
|
|
8488
|
-
item_description:
|
|
8487
|
+
item_product_name: "Deposit ",
|
|
8488
|
+
item_description: "Deposit for trip planning",
|
|
8489
8489
|
item_cost: 882.37,
|
|
8490
8490
|
item_qty: 1,
|
|
8491
8491
|
item_total_amount: 1
|
|
8492
8492
|
}],
|
|
8493
|
-
invoice_date:
|
|
8493
|
+
invoice_date: "2025-10-19",
|
|
8494
8494
|
invoice_type: 0,
|
|
8495
8495
|
invoice_status: 1,
|
|
8496
|
-
frequency:
|
|
8496
|
+
frequency: "onetime",
|
|
8497
8497
|
invoice_amount: 982.37,
|
|
8498
8498
|
discount: 10,
|
|
8499
|
-
invoice_number:
|
|
8499
|
+
invoice_number: "INV-3"
|
|
8500
8500
|
}
|
|
8501
|
-
)
|
|
8501
|
+
)
|
|
8502
8502
|
```
|
|
8503
8503
|
</dd>
|
|
8504
8504
|
</dl>
|
|
@@ -8585,9 +8585,9 @@ Deletes an invoice that's attached to a file.
|
|
|
8585
8585
|
|
|
8586
8586
|
```ruby
|
|
8587
8587
|
client.invoice.delete_attached_from_invoice(
|
|
8588
|
-
filename:
|
|
8588
|
+
filename: "0_Bill.pdf",
|
|
8589
8589
|
id_invoice: 23548884
|
|
8590
|
-
)
|
|
8590
|
+
)
|
|
8591
8591
|
```
|
|
8592
8592
|
</dd>
|
|
8593
8593
|
</dl>
|
|
@@ -8669,7 +8669,7 @@ Deletes a single invoice from an entrypoint.
|
|
|
8669
8669
|
<dd>
|
|
8670
8670
|
|
|
8671
8671
|
```ruby
|
|
8672
|
-
client.invoice.delete_invoice(id_invoice: 23548884)
|
|
8672
|
+
client.invoice.delete_invoice(id_invoice: 23548884)
|
|
8673
8673
|
```
|
|
8674
8674
|
</dd>
|
|
8675
8675
|
</dl>
|
|
@@ -8735,16 +8735,16 @@ client.invoice.edit_invoice(
|
|
|
8735
8735
|
id_invoice: 332,
|
|
8736
8736
|
invoice_data: {
|
|
8737
8737
|
items: [{
|
|
8738
|
-
item_product_name:
|
|
8739
|
-
item_description:
|
|
8738
|
+
item_product_name: "Deposit",
|
|
8739
|
+
item_description: "Deposit for trip planning",
|
|
8740
8740
|
item_cost: 882.37,
|
|
8741
8741
|
item_qty: 1
|
|
8742
8742
|
}],
|
|
8743
|
-
invoice_date:
|
|
8743
|
+
invoice_date: "2025-10-19",
|
|
8744
8744
|
invoice_amount: 982.37,
|
|
8745
|
-
invoice_number:
|
|
8745
|
+
invoice_number: "INV-6"
|
|
8746
8746
|
}
|
|
8747
|
-
)
|
|
8747
|
+
)
|
|
8748
8748
|
```
|
|
8749
8749
|
</dd>
|
|
8750
8750
|
</dl>
|
|
@@ -8824,8 +8824,8 @@ Retrieves a file attached to an invoice.
|
|
|
8824
8824
|
```ruby
|
|
8825
8825
|
client.invoice.get_attached_file_from_invoice(
|
|
8826
8826
|
id_invoice: 1,
|
|
8827
|
-
filename:
|
|
8828
|
-
)
|
|
8827
|
+
filename: "filename"
|
|
8828
|
+
)
|
|
8829
8829
|
```
|
|
8830
8830
|
</dd>
|
|
8831
8831
|
</dl>
|
|
@@ -8917,7 +8917,7 @@ Retrieves a single invoice by ID.
|
|
|
8917
8917
|
<dd>
|
|
8918
8918
|
|
|
8919
8919
|
```ruby
|
|
8920
|
-
client.invoice.get_invoice(id_invoice: 23548884)
|
|
8920
|
+
client.invoice.get_invoice(id_invoice: 23548884)
|
|
8921
8921
|
```
|
|
8922
8922
|
</dd>
|
|
8923
8923
|
</dl>
|
|
@@ -8979,7 +8979,7 @@ Retrieves the next available invoice number for a paypoint.
|
|
|
8979
8979
|
<dd>
|
|
8980
8980
|
|
|
8981
8981
|
```ruby
|
|
8982
|
-
client.invoice.get_invoice_number(entry:
|
|
8982
|
+
client.invoice.get_invoice_number(entry: "8cfec329267")
|
|
8983
8983
|
```
|
|
8984
8984
|
</dd>
|
|
8985
8985
|
</dl>
|
|
@@ -9042,11 +9042,11 @@ Returns a list of invoices for an entrypoint. Use filters to limit results. Incl
|
|
|
9042
9042
|
|
|
9043
9043
|
```ruby
|
|
9044
9044
|
client.invoice.list_invoices(
|
|
9045
|
-
entry:
|
|
9045
|
+
entry: "8cfec329267",
|
|
9046
9046
|
from_record: 251,
|
|
9047
9047
|
limit_record: 0,
|
|
9048
|
-
sort_by:
|
|
9049
|
-
)
|
|
9048
|
+
sort_by: "desc(field_name)"
|
|
9049
|
+
)
|
|
9050
9050
|
```
|
|
9051
9051
|
</dd>
|
|
9052
9052
|
</dl>
|
|
@@ -9216,8 +9216,8 @@ client.invoice.list_invoices_org(
|
|
|
9216
9216
|
org_id: 123,
|
|
9217
9217
|
from_record: 251,
|
|
9218
9218
|
limit_record: 0,
|
|
9219
|
-
sort_by:
|
|
9220
|
-
)
|
|
9219
|
+
sort_by: "desc(field_name)"
|
|
9220
|
+
)
|
|
9221
9221
|
```
|
|
9222
9222
|
</dd>
|
|
9223
9223
|
</dl>
|
|
@@ -9386,8 +9386,8 @@ Sends an invoice from an entrypoint via email.
|
|
|
9386
9386
|
client.invoice.send_invoice(
|
|
9387
9387
|
id_invoice: 23548884,
|
|
9388
9388
|
attachfile: true,
|
|
9389
|
-
mail_2:
|
|
9390
|
-
)
|
|
9389
|
+
mail_2: "tamara@example.com"
|
|
9390
|
+
)
|
|
9391
9391
|
```
|
|
9392
9392
|
</dd>
|
|
9393
9393
|
</dl>
|
|
@@ -9465,7 +9465,7 @@ Export a single invoice in PDF format.
|
|
|
9465
9465
|
<dd>
|
|
9466
9466
|
|
|
9467
9467
|
```ruby
|
|
9468
|
-
client.invoice.get_invoice_pdf(id_invoice: 23548884)
|
|
9468
|
+
client.invoice.get_invoice_pdf(id_invoice: 23548884)
|
|
9469
9469
|
```
|
|
9470
9470
|
</dd>
|
|
9471
9471
|
</dl>
|
|
@@ -9529,16 +9529,16 @@ Adds products and services to an entrypoint's catalog. These are used as line it
|
|
|
9529
9529
|
|
|
9530
9530
|
```ruby
|
|
9531
9531
|
client.line_item.add_item(
|
|
9532
|
-
entry:
|
|
9533
|
-
item_commodity_code:
|
|
9532
|
+
entry: "47cae3d74",
|
|
9533
|
+
item_commodity_code: "010",
|
|
9534
9534
|
item_cost: 12.45,
|
|
9535
|
-
item_description:
|
|
9535
|
+
item_description: "Deposit for materials",
|
|
9536
9536
|
item_mode: 0,
|
|
9537
|
-
item_product_code:
|
|
9538
|
-
item_product_name:
|
|
9537
|
+
item_product_code: "M-DEPOSIT",
|
|
9538
|
+
item_product_name: "Materials deposit",
|
|
9539
9539
|
item_qty: 1,
|
|
9540
|
-
item_unit_of_measure:
|
|
9541
|
-
)
|
|
9540
|
+
item_unit_of_measure: "SqFt"
|
|
9541
|
+
)
|
|
9542
9542
|
```
|
|
9543
9543
|
</dd>
|
|
9544
9544
|
</dl>
|
|
@@ -9616,7 +9616,7 @@ Deletes an item.
|
|
|
9616
9616
|
<dd>
|
|
9617
9617
|
|
|
9618
9618
|
```ruby
|
|
9619
|
-
client.line_item.delete_item(line_item_id: 700)
|
|
9619
|
+
client.line_item.delete_item(line_item_id: 700)
|
|
9620
9620
|
```
|
|
9621
9621
|
</dd>
|
|
9622
9622
|
</dl>
|
|
@@ -9678,7 +9678,7 @@ Gets an item by ID.
|
|
|
9678
9678
|
<dd>
|
|
9679
9679
|
|
|
9680
9680
|
```ruby
|
|
9681
|
-
client.line_item.get_item(line_item_id: 700)
|
|
9681
|
+
client.line_item.get_item(line_item_id: 700)
|
|
9682
9682
|
```
|
|
9683
9683
|
</dd>
|
|
9684
9684
|
</dl>
|
|
@@ -9741,11 +9741,11 @@ Retrieves a list of line items and their details from an entrypoint. Line items
|
|
|
9741
9741
|
|
|
9742
9742
|
```ruby
|
|
9743
9743
|
client.line_item.list_line_items(
|
|
9744
|
-
entry:
|
|
9744
|
+
entry: "8cfec329267",
|
|
9745
9745
|
from_record: 251,
|
|
9746
9746
|
limit_record: 0,
|
|
9747
|
-
sort_by:
|
|
9748
|
-
)
|
|
9747
|
+
sort_by: "desc(field_name)"
|
|
9748
|
+
)
|
|
9749
9749
|
```
|
|
9750
9750
|
</dd>
|
|
9751
9751
|
</dl>
|
|
@@ -9899,7 +9899,7 @@ client.line_item.update_item(
|
|
|
9899
9899
|
line_item_id: 700,
|
|
9900
9900
|
item_cost: 12.45,
|
|
9901
9901
|
item_qty: 1
|
|
9902
|
-
)
|
|
9902
|
+
)
|
|
9903
9903
|
```
|
|
9904
9904
|
</dd>
|
|
9905
9905
|
</dl>
|
|
@@ -9978,22 +9978,22 @@ client.money_in.authorize(
|
|
|
9978
9978
|
customer_data: {
|
|
9979
9979
|
customer_id: 4440
|
|
9980
9980
|
},
|
|
9981
|
-
entry_point:
|
|
9982
|
-
ipaddress:
|
|
9981
|
+
entry_point: "f743aed24a",
|
|
9982
|
+
ipaddress: "255.255.255.255",
|
|
9983
9983
|
payment_details: {
|
|
9984
9984
|
service_fee: 0,
|
|
9985
9985
|
total_amount: 100
|
|
9986
9986
|
},
|
|
9987
9987
|
payment_method: {
|
|
9988
|
-
cardcvv:
|
|
9989
|
-
cardexp:
|
|
9990
|
-
card_holder:
|
|
9991
|
-
cardnumber:
|
|
9992
|
-
cardzip:
|
|
9993
|
-
initiator:
|
|
9994
|
-
method_:
|
|
9988
|
+
cardcvv: "999",
|
|
9989
|
+
cardexp: "02/27",
|
|
9990
|
+
card_holder: "John Cassian",
|
|
9991
|
+
cardnumber: "4111111111111111",
|
|
9992
|
+
cardzip: "12345",
|
|
9993
|
+
initiator: "payor",
|
|
9994
|
+
method_: "card"
|
|
9995
9995
|
}
|
|
9996
|
-
)
|
|
9996
|
+
)
|
|
9997
9997
|
```
|
|
9998
9998
|
</dd>
|
|
9999
9999
|
</dl>
|
|
@@ -10077,9 +10077,9 @@ transaction](/developers/api-reference/moneyin/authorize-a-transaction) to compl
|
|
|
10077
10077
|
|
|
10078
10078
|
```ruby
|
|
10079
10079
|
client.money_in.capture(
|
|
10080
|
-
trans_id:
|
|
10080
|
+
trans_id: "10-7d9cd67d-2d5d-4cd7-a1b7-72b8b201ec13",
|
|
10081
10081
|
amount: 0
|
|
10082
|
-
)
|
|
10082
|
+
)
|
|
10083
10083
|
```
|
|
10084
10084
|
</dd>
|
|
10085
10085
|
</dl>
|
|
@@ -10156,12 +10156,12 @@ Consider migrating to the [v2 Capture endpoint](/developers/api-reference/moneyi
|
|
|
10156
10156
|
|
|
10157
10157
|
```ruby
|
|
10158
10158
|
client.money_in.capture_auth(
|
|
10159
|
-
trans_id:
|
|
10159
|
+
trans_id: "10-7d9cd67d-2d5d-4cd7-a1b7-72b8b201ec13",
|
|
10160
10160
|
payment_details: {
|
|
10161
10161
|
total_amount: 105,
|
|
10162
10162
|
service_fee: 5
|
|
10163
10163
|
}
|
|
10164
|
-
)
|
|
10164
|
+
)
|
|
10165
10165
|
```
|
|
10166
10166
|
</dd>
|
|
10167
10167
|
</dl>
|
|
@@ -10234,24 +10234,24 @@ This feature must be enabled by Payabli on a per-merchant basis. Contact support
|
|
|
10234
10234
|
|
|
10235
10235
|
```ruby
|
|
10236
10236
|
client.money_in.credit(
|
|
10237
|
-
idempotency_key:
|
|
10237
|
+
idempotency_key: "6B29FC40-CA47-1067-B31D-00DD010662DA",
|
|
10238
10238
|
customer_data: {
|
|
10239
|
-
billing_address_1:
|
|
10240
|
-
customer_number:
|
|
10239
|
+
billing_address_1: "5127 Linkwood ave",
|
|
10240
|
+
customer_number: "100"
|
|
10241
10241
|
},
|
|
10242
|
-
entrypoint:
|
|
10242
|
+
entrypoint: "my-entrypoint",
|
|
10243
10243
|
payment_details: {
|
|
10244
10244
|
service_fee: 0,
|
|
10245
10245
|
total_amount: 1
|
|
10246
10246
|
},
|
|
10247
10247
|
payment_method: {
|
|
10248
|
-
ach_account:
|
|
10249
|
-
ach_account_type:
|
|
10250
|
-
ach_holder:
|
|
10251
|
-
ach_routing:
|
|
10252
|
-
method_:
|
|
10248
|
+
ach_account: "88354454",
|
|
10249
|
+
ach_account_type: "Checking",
|
|
10250
|
+
ach_holder: "John Smith",
|
|
10251
|
+
ach_routing: "021000021",
|
|
10252
|
+
method_: "ach"
|
|
10253
10253
|
}
|
|
10254
|
-
)
|
|
10254
|
+
)
|
|
10255
10255
|
```
|
|
10256
10256
|
</dd>
|
|
10257
10257
|
</dl>
|
|
@@ -10393,7 +10393,7 @@ Retrieve a processed transaction's details.
|
|
|
10393
10393
|
<dd>
|
|
10394
10394
|
|
|
10395
10395
|
```ruby
|
|
10396
|
-
client.money_in.details(trans_id:
|
|
10396
|
+
client.money_in.details(trans_id: "45-as456777hhhhhhhhhh77777777-324")
|
|
10397
10397
|
```
|
|
10398
10398
|
</dd>
|
|
10399
10399
|
</dl>
|
|
@@ -10463,22 +10463,22 @@ client.money_in.getpaid(
|
|
|
10463
10463
|
customer_data: {
|
|
10464
10464
|
customer_id: 4440
|
|
10465
10465
|
},
|
|
10466
|
-
entry_point:
|
|
10467
|
-
ipaddress:
|
|
10466
|
+
entry_point: "f743aed24a",
|
|
10467
|
+
ipaddress: "255.255.255.255",
|
|
10468
10468
|
payment_details: {
|
|
10469
10469
|
service_fee: 0,
|
|
10470
10470
|
total_amount: 100
|
|
10471
10471
|
},
|
|
10472
10472
|
payment_method: {
|
|
10473
|
-
cardcvv:
|
|
10474
|
-
cardexp:
|
|
10475
|
-
card_holder:
|
|
10476
|
-
cardnumber:
|
|
10477
|
-
cardzip:
|
|
10478
|
-
initiator:
|
|
10479
|
-
method_:
|
|
10473
|
+
cardcvv: "999",
|
|
10474
|
+
cardexp: "02/27",
|
|
10475
|
+
card_holder: "John Cassian",
|
|
10476
|
+
cardnumber: "4111111111111111",
|
|
10477
|
+
cardzip: "12345",
|
|
10478
|
+
initiator: "payor",
|
|
10479
|
+
method_: "card"
|
|
10480
10480
|
}
|
|
10481
|
-
)
|
|
10481
|
+
)
|
|
10482
10482
|
```
|
|
10483
10483
|
</dd>
|
|
10484
10484
|
</dl>
|
|
@@ -10582,8 +10582,8 @@ A reversal either refunds or voids a transaction independent of the transaction'
|
|
|
10582
10582
|
```ruby
|
|
10583
10583
|
client.money_in.reverse(
|
|
10584
10584
|
amount: 0,
|
|
10585
|
-
trans_id:
|
|
10586
|
-
)
|
|
10585
|
+
trans_id: "10-3ffa27df-b171-44e0-b251-e95fbfc7a723"
|
|
10586
|
+
)
|
|
10587
10587
|
```
|
|
10588
10588
|
</dd>
|
|
10589
10589
|
</dl>
|
|
@@ -10666,8 +10666,8 @@ Refund a transaction that has settled and send money back to the account holder.
|
|
|
10666
10666
|
```ruby
|
|
10667
10667
|
client.money_in.refund(
|
|
10668
10668
|
amount: 0,
|
|
10669
|
-
trans_id:
|
|
10670
|
-
)
|
|
10669
|
+
trans_id: "10-3ffa27df-b171-44e0-b251-e95fbfc7a723"
|
|
10670
|
+
)
|
|
10671
10671
|
```
|
|
10672
10672
|
</dd>
|
|
10673
10673
|
</dl>
|
|
@@ -10745,25 +10745,25 @@ Refunds a settled transaction with split instructions.
|
|
|
10745
10745
|
|
|
10746
10746
|
```ruby
|
|
10747
10747
|
client.money_in.refund_with_instructions(
|
|
10748
|
-
trans_id:
|
|
10749
|
-
idempotency_key:
|
|
10750
|
-
source:
|
|
10751
|
-
order_description:
|
|
10748
|
+
trans_id: "10-3ffa27df-b171-44e0-b251-e95fbfc7a723",
|
|
10749
|
+
idempotency_key: "8A29FC40-CA47-1067-B31D-00DD010662DB",
|
|
10750
|
+
source: "api",
|
|
10751
|
+
order_description: "Materials deposit",
|
|
10752
10752
|
amount: 100,
|
|
10753
10753
|
refund_details: {
|
|
10754
10754
|
split_refunding: [{
|
|
10755
|
-
origination_entry_point:
|
|
10756
|
-
account_id:
|
|
10757
|
-
description:
|
|
10755
|
+
origination_entry_point: "7f1a381696",
|
|
10756
|
+
account_id: "187-342",
|
|
10757
|
+
description: "Refunding undelivered materials",
|
|
10758
10758
|
amount: 60
|
|
10759
10759
|
}, {
|
|
10760
|
-
origination_entry_point:
|
|
10761
|
-
account_id:
|
|
10762
|
-
description:
|
|
10760
|
+
origination_entry_point: "7f1a381696",
|
|
10761
|
+
account_id: "187-343",
|
|
10762
|
+
description: "Refunding deposit for undelivered materials",
|
|
10763
10763
|
amount: 40
|
|
10764
10764
|
}]
|
|
10765
10765
|
}
|
|
10766
|
-
)
|
|
10766
|
+
)
|
|
10767
10767
|
```
|
|
10768
10768
|
</dd>
|
|
10769
10769
|
</dl>
|
|
@@ -10888,7 +10888,7 @@ Reverse microdeposits that are used to verify customer account ownership and acc
|
|
|
10888
10888
|
<dd>
|
|
10889
10889
|
|
|
10890
10890
|
```ruby
|
|
10891
|
-
client.money_in.reverse_credit(trans_id:
|
|
10891
|
+
client.money_in.reverse_credit(trans_id: "45-as456777hhhhhhhhhh77777777-324")
|
|
10892
10892
|
```
|
|
10893
10893
|
</dd>
|
|
10894
10894
|
</dl>
|
|
@@ -10951,9 +10951,9 @@ Send a payment receipt for a transaction.
|
|
|
10951
10951
|
|
|
10952
10952
|
```ruby
|
|
10953
10953
|
client.money_in.send_receipt_2_trans(
|
|
10954
|
-
trans_id:
|
|
10955
|
-
email:
|
|
10956
|
-
)
|
|
10954
|
+
trans_id: "45-as456777hhhhhhhhhh77777777-324",
|
|
10955
|
+
email: "example@email.com"
|
|
10956
|
+
)
|
|
10957
10957
|
```
|
|
10958
10958
|
</dd>
|
|
10959
10959
|
</dl>
|
|
@@ -11028,16 +11028,16 @@ Validates a card number without running a transaction or authorizing a charge.
|
|
|
11028
11028
|
|
|
11029
11029
|
```ruby
|
|
11030
11030
|
client.money_in.validate(
|
|
11031
|
-
idempotency_key:
|
|
11032
|
-
entry_point:
|
|
11031
|
+
idempotency_key: "6B29FC40-CA47-1067-B31D-00DD010662DA",
|
|
11032
|
+
entry_point: "entry132",
|
|
11033
11033
|
payment_method: {
|
|
11034
|
-
method_:
|
|
11035
|
-
cardnumber:
|
|
11036
|
-
cardexp:
|
|
11037
|
-
cardzip:
|
|
11038
|
-
card_holder:
|
|
11034
|
+
method_: "card",
|
|
11035
|
+
cardnumber: "4360000001000005",
|
|
11036
|
+
cardexp: "12/29",
|
|
11037
|
+
cardzip: "14602-8328",
|
|
11038
|
+
card_holder: "Dianne Becker-Smith"
|
|
11039
11039
|
}
|
|
11040
|
-
)
|
|
11040
|
+
)
|
|
11041
11041
|
```
|
|
11042
11042
|
</dd>
|
|
11043
11043
|
</dl>
|
|
@@ -11143,7 +11143,7 @@ Cancel a transaction that hasn't been settled yet. Voiding non-captured authoriz
|
|
|
11143
11143
|
<dd>
|
|
11144
11144
|
|
|
11145
11145
|
```ruby
|
|
11146
|
-
client.money_in.void(trans_id:
|
|
11146
|
+
client.money_in.void(trans_id: "10-3ffa27df-b171-44e0-b251-e95fbfc7a723")
|
|
11147
11147
|
```
|
|
11148
11148
|
</dd>
|
|
11149
11149
|
</dl>
|
|
@@ -11209,22 +11209,22 @@ client.money_in.getpaidv_2(
|
|
|
11209
11209
|
customer_data: {
|
|
11210
11210
|
customer_id: 4440
|
|
11211
11211
|
},
|
|
11212
|
-
entry_point:
|
|
11213
|
-
ipaddress:
|
|
11212
|
+
entry_point: "f743aed24a",
|
|
11213
|
+
ipaddress: "255.255.255.255",
|
|
11214
11214
|
payment_details: {
|
|
11215
11215
|
service_fee: 0,
|
|
11216
11216
|
total_amount: 100
|
|
11217
11217
|
},
|
|
11218
11218
|
payment_method: {
|
|
11219
|
-
cardcvv:
|
|
11220
|
-
cardexp:
|
|
11221
|
-
card_holder:
|
|
11222
|
-
cardnumber:
|
|
11223
|
-
cardzip:
|
|
11224
|
-
initiator:
|
|
11225
|
-
method_:
|
|
11219
|
+
cardcvv: "999",
|
|
11220
|
+
cardexp: "02/27",
|
|
11221
|
+
card_holder: "John Cassian",
|
|
11222
|
+
cardnumber: "4111111111111111",
|
|
11223
|
+
cardzip: "12345",
|
|
11224
|
+
initiator: "payor",
|
|
11225
|
+
method_: "card"
|
|
11226
11226
|
}
|
|
11227
|
-
)
|
|
11227
|
+
)
|
|
11228
11228
|
```
|
|
11229
11229
|
</dd>
|
|
11230
11230
|
</dl>
|
|
@@ -11324,22 +11324,22 @@ client.money_in.authorizev_2(
|
|
|
11324
11324
|
customer_data: {
|
|
11325
11325
|
customer_id: 4440
|
|
11326
11326
|
},
|
|
11327
|
-
entry_point:
|
|
11328
|
-
ipaddress:
|
|
11327
|
+
entry_point: "f743aed24a",
|
|
11328
|
+
ipaddress: "255.255.255.255",
|
|
11329
11329
|
payment_details: {
|
|
11330
11330
|
service_fee: 0,
|
|
11331
11331
|
total_amount: 100
|
|
11332
11332
|
},
|
|
11333
11333
|
payment_method: {
|
|
11334
|
-
cardcvv:
|
|
11335
|
-
cardexp:
|
|
11336
|
-
card_holder:
|
|
11337
|
-
cardnumber:
|
|
11338
|
-
cardzip:
|
|
11339
|
-
initiator:
|
|
11340
|
-
method_:
|
|
11334
|
+
cardcvv: "999",
|
|
11335
|
+
cardexp: "02/27",
|
|
11336
|
+
card_holder: "John Cassian",
|
|
11337
|
+
cardnumber: "4111111111111111",
|
|
11338
|
+
cardzip: "12345",
|
|
11339
|
+
initiator: "payor",
|
|
11340
|
+
method_: "card"
|
|
11341
11341
|
}
|
|
11342
|
-
)
|
|
11342
|
+
)
|
|
11343
11343
|
```
|
|
11344
11344
|
</dd>
|
|
11345
11345
|
</dl>
|
|
@@ -11418,12 +11418,12 @@ Capture an authorized transaction to complete the transaction and move funds fro
|
|
|
11418
11418
|
|
|
11419
11419
|
```ruby
|
|
11420
11420
|
client.money_in.capturev_2(
|
|
11421
|
-
trans_id:
|
|
11421
|
+
trans_id: "10-7d9cd67d-2d5d-4cd7-a1b7-72b8b201ec13",
|
|
11422
11422
|
payment_details: {
|
|
11423
11423
|
total_amount: 105,
|
|
11424
11424
|
service_fee: 5
|
|
11425
11425
|
}
|
|
11426
|
-
)
|
|
11426
|
+
)
|
|
11427
11427
|
```
|
|
11428
11428
|
</dd>
|
|
11429
11429
|
</dl>
|
|
@@ -11495,7 +11495,7 @@ This is the v2 version of the refund endpoint, and returns the unified response
|
|
|
11495
11495
|
<dd>
|
|
11496
11496
|
|
|
11497
11497
|
```ruby
|
|
11498
|
-
client.money_in.refundv_2(trans_id:
|
|
11498
|
+
client.money_in.refundv_2(trans_id: "10-3ffa27df-b171-44e0-b251-e95fbfc7a723")
|
|
11499
11499
|
```
|
|
11500
11500
|
</dd>
|
|
11501
11501
|
</dl>
|
|
@@ -11560,9 +11560,9 @@ This is the v2 version of the refund endpoint, and returns the unified response
|
|
|
11560
11560
|
|
|
11561
11561
|
```ruby
|
|
11562
11562
|
client.money_in.refundv_2_amount(
|
|
11563
|
-
trans_id:
|
|
11563
|
+
trans_id: "10-3ffa27df-b171-44e0-b251-e95fbfc7a723",
|
|
11564
11564
|
amount: 0
|
|
11565
|
-
)
|
|
11565
|
+
)
|
|
11566
11566
|
```
|
|
11567
11567
|
</dd>
|
|
11568
11568
|
</dl>
|
|
@@ -11632,7 +11632,7 @@ Cancel a transaction that hasn't been settled yet. Voiding non-captured authoriz
|
|
|
11632
11632
|
<dd>
|
|
11633
11633
|
|
|
11634
11634
|
```ruby
|
|
11635
|
-
client.money_in.voidv_2(trans_id:
|
|
11635
|
+
client.money_in.voidv_2(trans_id: "10-3ffa27df-b171-44e0-b251-e95fbfc7a723")
|
|
11636
11636
|
```
|
|
11637
11637
|
</dd>
|
|
11638
11638
|
</dl>
|
|
@@ -11696,22 +11696,22 @@ Authorizes transaction for payout. Authorized transactions aren't flagged for se
|
|
|
11696
11696
|
|
|
11697
11697
|
```ruby
|
|
11698
11698
|
client.money_out.authorize_out(
|
|
11699
|
-
entry_point:
|
|
11700
|
-
order_description:
|
|
11699
|
+
entry_point: "48acde49",
|
|
11700
|
+
order_description: "Window Painting",
|
|
11701
11701
|
payment_method: {
|
|
11702
|
-
method_:
|
|
11702
|
+
method_: "managed"
|
|
11703
11703
|
},
|
|
11704
11704
|
payment_details: {
|
|
11705
11705
|
total_amount: 47,
|
|
11706
11706
|
unbundled: false
|
|
11707
11707
|
},
|
|
11708
11708
|
vendor_data: {
|
|
11709
|
-
vendor_number:
|
|
11709
|
+
vendor_number: "7895433"
|
|
11710
11710
|
},
|
|
11711
11711
|
invoice_data: [{
|
|
11712
11712
|
bill_id: 54323
|
|
11713
11713
|
}]
|
|
11714
|
-
)
|
|
11714
|
+
)
|
|
11715
11715
|
```
|
|
11716
11716
|
</dd>
|
|
11717
11717
|
</dl>
|
|
@@ -11805,7 +11805,7 @@ Cancels an array of payout transactions.
|
|
|
11805
11805
|
<dd>
|
|
11806
11806
|
|
|
11807
11807
|
```ruby
|
|
11808
|
-
client.money_out.cancel_all_out(request: [
|
|
11808
|
+
client.money_out.cancel_all_out(request: %w[2-29 2-28 2-27])
|
|
11809
11809
|
```
|
|
11810
11810
|
</dd>
|
|
11811
11811
|
</dl>
|
|
@@ -11867,7 +11867,7 @@ Cancel a payout transaction by ID.
|
|
|
11867
11867
|
<dd>
|
|
11868
11868
|
|
|
11869
11869
|
```ruby
|
|
11870
|
-
client.money_out.cancel_out_get(reference_id:
|
|
11870
|
+
client.money_out.cancel_out_get(reference_id: "129-219")
|
|
11871
11871
|
```
|
|
11872
11872
|
</dd>
|
|
11873
11873
|
</dl>
|
|
@@ -11929,7 +11929,7 @@ Cancel a payout transaction by ID.
|
|
|
11929
11929
|
<dd>
|
|
11930
11930
|
|
|
11931
11931
|
```ruby
|
|
11932
|
-
client.money_out.cancel_out_delete(reference_id:
|
|
11932
|
+
client.money_out.cancel_out_delete(reference_id: "129-219")
|
|
11933
11933
|
```
|
|
11934
11934
|
</dd>
|
|
11935
11935
|
</dl>
|
|
@@ -11991,7 +11991,7 @@ Captures an array of authorized payout transactions for settlement. The maximum
|
|
|
11991
11991
|
<dd>
|
|
11992
11992
|
|
|
11993
11993
|
```ruby
|
|
11994
|
-
client.money_out.capture_all_out(body: [
|
|
11994
|
+
client.money_out.capture_all_out(body: %w[2-29 2-28 2-27])
|
|
11995
11995
|
```
|
|
11996
11996
|
</dd>
|
|
11997
11997
|
</dl>
|
|
@@ -12061,7 +12061,7 @@ Captures a single authorized payout transaction by ID.
|
|
|
12061
12061
|
<dd>
|
|
12062
12062
|
|
|
12063
12063
|
```ruby
|
|
12064
|
-
client.money_out.capture_out(reference_id:
|
|
12064
|
+
client.money_out.capture_out(reference_id: "129-219")
|
|
12065
12065
|
```
|
|
12066
12066
|
</dd>
|
|
12067
12067
|
</dl>
|
|
@@ -12131,7 +12131,7 @@ Returns details for a processed money out transaction.
|
|
|
12131
12131
|
<dd>
|
|
12132
12132
|
|
|
12133
12133
|
```ruby
|
|
12134
|
-
client.money_out.payout_details(trans_id:
|
|
12134
|
+
client.money_out.payout_details(trans_id: "45-as456777hhhhhhhhhh77777777-324")
|
|
12135
12135
|
```
|
|
12136
12136
|
</dd>
|
|
12137
12137
|
</dl>
|
|
@@ -12193,7 +12193,7 @@ Retrieves vCard details for a single card in an entrypoint.
|
|
|
12193
12193
|
<dd>
|
|
12194
12194
|
|
|
12195
12195
|
```ruby
|
|
12196
|
-
client.money_out.v_card_get(card_token:
|
|
12196
|
+
client.money_out.v_card_get(card_token: "20230403315245421165")
|
|
12197
12197
|
```
|
|
12198
12198
|
</dd>
|
|
12199
12199
|
</dl>
|
|
@@ -12255,7 +12255,7 @@ Sends a virtual card link via email to the vendor associated with the `transId`.
|
|
|
12255
12255
|
<dd>
|
|
12256
12256
|
|
|
12257
12257
|
```ruby
|
|
12258
|
-
client.money_out.send_v_card_link(trans_id:
|
|
12258
|
+
client.money_out.send_v_card_link(trans_id: "01K33Z6YQZ6GD5QVKZ856MJBSC")
|
|
12259
12259
|
```
|
|
12260
12260
|
</dd>
|
|
12261
12261
|
</dl>
|
|
@@ -12319,7 +12319,7 @@ The check image is only available for payouts that have been processed.
|
|
|
12319
12319
|
<dd>
|
|
12320
12320
|
|
|
12321
12321
|
```ruby
|
|
12322
|
-
client.money_out.get_check_image(asset_name:
|
|
12322
|
+
client.money_out.get_check_image(asset_name: "check133832686289732320_01JKBNZ5P32JPTZY8XXXX000000.pdf")
|
|
12323
12323
|
```
|
|
12324
12324
|
</dd>
|
|
12325
12325
|
</dl>
|
|
@@ -12361,6 +12361,90 @@ in the response when you make a GET request to `/MoneyOut/details/{transId}`.
|
|
|
12361
12361
|
</dl>
|
|
12362
12362
|
|
|
12363
12363
|
|
|
12364
|
+
</dd>
|
|
12365
|
+
</dl>
|
|
12366
|
+
</details>
|
|
12367
|
+
|
|
12368
|
+
<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">update_check_payment_status</a>(trans_id, check_payment_status) -> Payabli::Types::PayabliApiResponse00Responsedatanonobject</code></summary>
|
|
12369
|
+
<dl>
|
|
12370
|
+
<dd>
|
|
12371
|
+
|
|
12372
|
+
#### 📝 Description
|
|
12373
|
+
|
|
12374
|
+
<dl>
|
|
12375
|
+
<dd>
|
|
12376
|
+
|
|
12377
|
+
<dl>
|
|
12378
|
+
<dd>
|
|
12379
|
+
|
|
12380
|
+
Updates the status of a processed check payment transaction. This endpoint handles the status transition, updates related bills, creates audit events, and triggers notifications.
|
|
12381
|
+
|
|
12382
|
+
The transaction must meet all of the following criteria:
|
|
12383
|
+
- **Status**: Must be in Processing or Processed status.
|
|
12384
|
+
- **Payment method**: Must be a check payment method.
|
|
12385
|
+
|
|
12386
|
+
### Allowed status values
|
|
12387
|
+
|
|
12388
|
+
| Value | Status | Description |
|
|
12389
|
+
|-------|--------|-------------|
|
|
12390
|
+
| `0` | Cancelled/Voided | Cancels the check transaction. Reverts associated bills to their previous state (Approved or Active), creates "Cancelled" events, and sends a `payout_transaction_voidedcancelled` notification if the notification is enabled. |
|
|
12391
|
+
| `5` | Paid | Marks the check transaction as paid. Updates associated bills to "Paid" status, creates "Paid" events, and sends a `payout_transaction_paid` notification if the notification is enabled. |
|
|
12392
|
+
</dd>
|
|
12393
|
+
</dl>
|
|
12394
|
+
</dd>
|
|
12395
|
+
</dl>
|
|
12396
|
+
|
|
12397
|
+
#### 🔌 Usage
|
|
12398
|
+
|
|
12399
|
+
<dl>
|
|
12400
|
+
<dd>
|
|
12401
|
+
|
|
12402
|
+
<dl>
|
|
12403
|
+
<dd>
|
|
12404
|
+
|
|
12405
|
+
```ruby
|
|
12406
|
+
client.money_out.update_check_payment_status(
|
|
12407
|
+
trans_id: "TRANS123456",
|
|
12408
|
+
check_payment_status: "5"
|
|
12409
|
+
)
|
|
12410
|
+
```
|
|
12411
|
+
</dd>
|
|
12412
|
+
</dl>
|
|
12413
|
+
</dd>
|
|
12414
|
+
</dl>
|
|
12415
|
+
|
|
12416
|
+
#### ⚙️ Parameters
|
|
12417
|
+
|
|
12418
|
+
<dl>
|
|
12419
|
+
<dd>
|
|
12420
|
+
|
|
12421
|
+
<dl>
|
|
12422
|
+
<dd>
|
|
12423
|
+
|
|
12424
|
+
**trans_id:** `String` — The Payabli transaction ID for the check payment.
|
|
12425
|
+
|
|
12426
|
+
</dd>
|
|
12427
|
+
</dl>
|
|
12428
|
+
|
|
12429
|
+
<dl>
|
|
12430
|
+
<dd>
|
|
12431
|
+
|
|
12432
|
+
**check_payment_status:** `Payabli::MoneyOutTypes::Types::AllowedCheckPaymentStatus` — The new status to apply to the check transaction. To mark a check as `Paid`, send 5. To mark a check as `Cancelled`, send 0.
|
|
12433
|
+
|
|
12434
|
+
</dd>
|
|
12435
|
+
</dl>
|
|
12436
|
+
|
|
12437
|
+
<dl>
|
|
12438
|
+
<dd>
|
|
12439
|
+
|
|
12440
|
+
**request_options:** `Payabli::MoneyOut::RequestOptions`
|
|
12441
|
+
|
|
12442
|
+
</dd>
|
|
12443
|
+
</dl>
|
|
12444
|
+
</dd>
|
|
12445
|
+
</dl>
|
|
12446
|
+
|
|
12447
|
+
|
|
12364
12448
|
</dd>
|
|
12365
12449
|
</dl>
|
|
12366
12450
|
</details>
|
|
@@ -12395,15 +12479,15 @@ Create a new notification or autogenerated report.
|
|
|
12395
12479
|
```ruby
|
|
12396
12480
|
client.notification.add_notification(
|
|
12397
12481
|
content: {
|
|
12398
|
-
event_type:
|
|
12482
|
+
event_type: "CreatedApplication"
|
|
12399
12483
|
},
|
|
12400
|
-
frequency:
|
|
12401
|
-
method_:
|
|
12402
|
-
owner_id:
|
|
12484
|
+
frequency: "untilcancelled",
|
|
12485
|
+
method_: "web",
|
|
12486
|
+
owner_id: "236",
|
|
12403
12487
|
owner_type: 0,
|
|
12404
12488
|
status: 1,
|
|
12405
|
-
target:
|
|
12406
|
-
)
|
|
12489
|
+
target: "https://webhook.site/2871b8f8-edc7-441a-b376-98d8c8e33275"
|
|
12490
|
+
)
|
|
12407
12491
|
```
|
|
12408
12492
|
</dd>
|
|
12409
12493
|
</dl>
|
|
@@ -12465,7 +12549,7 @@ Deletes a single notification or autogenerated report.
|
|
|
12465
12549
|
<dd>
|
|
12466
12550
|
|
|
12467
12551
|
```ruby
|
|
12468
|
-
client.notification.delete_notification(n_id:
|
|
12552
|
+
client.notification.delete_notification(n_id: "1717")
|
|
12469
12553
|
```
|
|
12470
12554
|
</dd>
|
|
12471
12555
|
</dl>
|
|
@@ -12527,7 +12611,7 @@ Retrieves a single notification or autogenerated report's details.
|
|
|
12527
12611
|
<dd>
|
|
12528
12612
|
|
|
12529
12613
|
```ruby
|
|
12530
|
-
client.notification.get_notification(n_id:
|
|
12614
|
+
client.notification.get_notification(n_id: "1717")
|
|
12531
12615
|
```
|
|
12532
12616
|
</dd>
|
|
12533
12617
|
</dl>
|
|
@@ -12590,17 +12674,17 @@ Update a notification or autogenerated report.
|
|
|
12590
12674
|
|
|
12591
12675
|
```ruby
|
|
12592
12676
|
client.notification.update_notification(
|
|
12593
|
-
n_id:
|
|
12677
|
+
n_id: "1717",
|
|
12594
12678
|
content: {
|
|
12595
|
-
event_type:
|
|
12679
|
+
event_type: "ApprovedPayment"
|
|
12596
12680
|
},
|
|
12597
|
-
frequency:
|
|
12598
|
-
method_:
|
|
12599
|
-
owner_id:
|
|
12681
|
+
frequency: "untilcancelled",
|
|
12682
|
+
method_: "email",
|
|
12683
|
+
owner_id: "136",
|
|
12600
12684
|
owner_type: 0,
|
|
12601
12685
|
status: 1,
|
|
12602
|
-
target:
|
|
12603
|
-
)
|
|
12686
|
+
target: "newemail@email.com"
|
|
12687
|
+
)
|
|
12604
12688
|
```
|
|
12605
12689
|
</dd>
|
|
12606
12690
|
</dl>
|
|
@@ -12670,7 +12754,7 @@ Gets a copy of a generated report by ID.
|
|
|
12670
12754
|
<dd>
|
|
12671
12755
|
|
|
12672
12756
|
```ruby
|
|
12673
|
-
client.notification.get_report_file(id: 1000000)
|
|
12757
|
+
client.notification.get_report_file(id: 1000000)
|
|
12674
12758
|
```
|
|
12675
12759
|
</dd>
|
|
12676
12760
|
</dl>
|
|
@@ -12739,12 +12823,12 @@ This endpoint requires the `notifications_create` OR `notifications_read` permis
|
|
|
12739
12823
|
```ruby
|
|
12740
12824
|
client.notificationlogs.search_notification_logs(
|
|
12741
12825
|
page_size: 20,
|
|
12742
|
-
start_date:
|
|
12743
|
-
end_date:
|
|
12744
|
-
notification_event:
|
|
12826
|
+
start_date: "2024-01-01T00:00:00Z",
|
|
12827
|
+
end_date: "2024-01-31T23:59:59Z",
|
|
12828
|
+
notification_event: "ActivatedMerchant",
|
|
12745
12829
|
succeeded: true,
|
|
12746
12830
|
org_id: 12345
|
|
12747
|
-
)
|
|
12831
|
+
)
|
|
12748
12832
|
```
|
|
12749
12833
|
</dd>
|
|
12750
12834
|
</dl>
|
|
@@ -12823,7 +12907,7 @@ This endpoint requires the `notifications_create` OR `notifications_read` permis
|
|
|
12823
12907
|
<dd>
|
|
12824
12908
|
|
|
12825
12909
|
```ruby
|
|
12826
|
-
client.notificationlogs.get_notification_log(uuid:
|
|
12910
|
+
client.notificationlogs.get_notification_log(uuid: "550e8400-e29b-41d4-a716-446655440000")
|
|
12827
12911
|
```
|
|
12828
12912
|
</dd>
|
|
12829
12913
|
</dl>
|
|
@@ -12887,7 +12971,7 @@ Retry sending a specific notification.
|
|
|
12887
12971
|
<dd>
|
|
12888
12972
|
|
|
12889
12973
|
```ruby
|
|
12890
|
-
client.notificationlogs.retry_notification_log(uuid:
|
|
12974
|
+
client.notificationlogs.retry_notification_log(uuid: "550e8400-e29b-41d4-a716-446655440000")
|
|
12891
12975
|
```
|
|
12892
12976
|
</dd>
|
|
12893
12977
|
</dl>
|
|
@@ -12952,7 +13036,7 @@ This endpoint requires the `notifications_create` permission.
|
|
|
12952
13036
|
<dd>
|
|
12953
13037
|
|
|
12954
13038
|
```ruby
|
|
12955
|
-
client.notificationlogs.bulk_retry_notification_logs(request: [
|
|
13039
|
+
client.notificationlogs.bulk_retry_notification_logs(request: %w[550e8400-e29b-41d4-a716-446655440000 550e8400-e29b-41d4-a716-446655440001 550e8400-e29b-41d4-a716-446655440002])
|
|
12956
13040
|
```
|
|
12957
13041
|
</dd>
|
|
12958
13042
|
</dl>
|
|
@@ -13015,7 +13099,7 @@ Use this endpoint to upload an image file for OCR processing. The accepted file
|
|
|
13015
13099
|
<dd>
|
|
13016
13100
|
|
|
13017
13101
|
```ruby
|
|
13018
|
-
client.ocr.ocr_document_form(type_result:
|
|
13102
|
+
client.ocr.ocr_document_form(type_result: "typeResult")
|
|
13019
13103
|
```
|
|
13020
13104
|
</dd>
|
|
13021
13105
|
</dl>
|
|
@@ -13085,7 +13169,7 @@ Use this endpoint to submit a Base64-encoded image file for OCR processing. The
|
|
|
13085
13169
|
<dd>
|
|
13086
13170
|
|
|
13087
13171
|
```ruby
|
|
13088
|
-
client.ocr.ocr_document_json(type_result:
|
|
13172
|
+
client.ocr.ocr_document_json(type_result: "typeResult")
|
|
13089
13173
|
```
|
|
13090
13174
|
</dd>
|
|
13091
13175
|
</dl>
|
|
@@ -13157,44 +13241,44 @@ Creates an organization under a parent organization. This is also referred to as
|
|
|
13157
13241
|
|
|
13158
13242
|
```ruby
|
|
13159
13243
|
client.organization.add_organization(
|
|
13160
|
-
idempotency_key:
|
|
13244
|
+
idempotency_key: "6B29FC40-CA47-1067-B31D-00DD010662DA",
|
|
13161
13245
|
billing_info: {
|
|
13162
|
-
ach_account:
|
|
13163
|
-
ach_routing:
|
|
13164
|
-
billing_address:
|
|
13165
|
-
billing_city:
|
|
13166
|
-
billing_country:
|
|
13167
|
-
billing_state:
|
|
13168
|
-
billing_zip:
|
|
13246
|
+
ach_account: "123123123",
|
|
13247
|
+
ach_routing: "123123123",
|
|
13248
|
+
billing_address: "123 Walnut Street",
|
|
13249
|
+
billing_city: "Johnson City",
|
|
13250
|
+
billing_country: "US",
|
|
13251
|
+
billing_state: "TN",
|
|
13252
|
+
billing_zip: "37615"
|
|
13169
13253
|
},
|
|
13170
13254
|
contacts: [{
|
|
13171
|
-
contact_email:
|
|
13172
|
-
contact_name:
|
|
13173
|
-
contact_phone:
|
|
13174
|
-
contact_title:
|
|
13255
|
+
contact_email: "herman@hermanscoatings.com",
|
|
13256
|
+
contact_name: "Herman Martinez",
|
|
13257
|
+
contact_phone: "3055550000",
|
|
13258
|
+
contact_title: "Owner"
|
|
13175
13259
|
}],
|
|
13176
13260
|
has_billing: true,
|
|
13177
13261
|
has_residual: true,
|
|
13178
|
-
org_address:
|
|
13179
|
-
org_city:
|
|
13180
|
-
org_country:
|
|
13181
|
-
org_entry_name:
|
|
13182
|
-
org_id:
|
|
13262
|
+
org_address: "123 Walnut Street",
|
|
13263
|
+
org_city: "Johnson City",
|
|
13264
|
+
org_country: "US",
|
|
13265
|
+
org_entry_name: "pilgrim-planner",
|
|
13266
|
+
org_id: "123",
|
|
13183
13267
|
org_logo: {
|
|
13184
|
-
f_content:
|
|
13185
|
-
filename:
|
|
13186
|
-
ftype:
|
|
13187
|
-
furl:
|
|
13268
|
+
f_content: "TXkgdGVzdCBmaWxlHJ==...",
|
|
13269
|
+
filename: "my-doc.pdf",
|
|
13270
|
+
ftype: "pdf",
|
|
13271
|
+
furl: "https://mysite.com/my-doc.pdf"
|
|
13188
13272
|
},
|
|
13189
|
-
org_name:
|
|
13273
|
+
org_name: "Pilgrim Planner",
|
|
13190
13274
|
org_parent_id: 236,
|
|
13191
|
-
org_state:
|
|
13275
|
+
org_state: "TN",
|
|
13192
13276
|
org_timezone: -5,
|
|
13193
13277
|
org_type: 0,
|
|
13194
|
-
org_website:
|
|
13195
|
-
org_zip:
|
|
13196
|
-
reply_to_email:
|
|
13197
|
-
)
|
|
13278
|
+
org_website: "www.pilgrimageplanner.com",
|
|
13279
|
+
org_zip: "37615",
|
|
13280
|
+
reply_to_email: "email@example.com"
|
|
13281
|
+
)
|
|
13198
13282
|
```
|
|
13199
13283
|
</dd>
|
|
13200
13284
|
</dl>
|
|
@@ -13408,7 +13492,7 @@ Delete an organization by ID.
|
|
|
13408
13492
|
<dd>
|
|
13409
13493
|
|
|
13410
13494
|
```ruby
|
|
13411
|
-
client.organization.delete_organization(org_id: 123)
|
|
13495
|
+
client.organization.delete_organization(org_id: 123)
|
|
13412
13496
|
```
|
|
13413
13497
|
</dd>
|
|
13414
13498
|
</dl>
|
|
@@ -13473,23 +13557,23 @@ Updates an organization's details by ID.
|
|
|
13473
13557
|
client.organization.edit_organization(
|
|
13474
13558
|
org_id: 123,
|
|
13475
13559
|
contacts: [{
|
|
13476
|
-
contact_email:
|
|
13477
|
-
contact_name:
|
|
13478
|
-
contact_phone:
|
|
13479
|
-
contact_title:
|
|
13560
|
+
contact_email: "herman@hermanscoatings.com",
|
|
13561
|
+
contact_name: "Herman Martinez",
|
|
13562
|
+
contact_phone: "3055550000",
|
|
13563
|
+
contact_title: "Owner"
|
|
13480
13564
|
}],
|
|
13481
|
-
org_address:
|
|
13482
|
-
org_city:
|
|
13483
|
-
org_country:
|
|
13484
|
-
org_entry_name:
|
|
13485
|
-
organization_data_org_id:
|
|
13486
|
-
org_name:
|
|
13487
|
-
org_state:
|
|
13565
|
+
org_address: "123 Walnut Street",
|
|
13566
|
+
org_city: "Johnson City",
|
|
13567
|
+
org_country: "US",
|
|
13568
|
+
org_entry_name: "pilgrim-planner",
|
|
13569
|
+
organization_data_org_id: "123",
|
|
13570
|
+
org_name: "Pilgrim Planner",
|
|
13571
|
+
org_state: "TN",
|
|
13488
13572
|
org_timezone: -5,
|
|
13489
13573
|
org_type: 0,
|
|
13490
|
-
org_website:
|
|
13491
|
-
org_zip:
|
|
13492
|
-
)
|
|
13574
|
+
org_website: "www.pilgrimageplanner.com",
|
|
13575
|
+
org_zip: "37615"
|
|
13576
|
+
)
|
|
13493
13577
|
```
|
|
13494
13578
|
</dd>
|
|
13495
13579
|
</dl>
|
|
@@ -13703,7 +13787,7 @@ Gets an organization's basic information by entry name (entrypoint identifier).
|
|
|
13703
13787
|
<dd>
|
|
13704
13788
|
|
|
13705
13789
|
```ruby
|
|
13706
|
-
client.organization.get_basic_organization(entry:
|
|
13790
|
+
client.organization.get_basic_organization(entry: "8cfec329267")
|
|
13707
13791
|
```
|
|
13708
13792
|
</dd>
|
|
13709
13793
|
</dl>
|
|
@@ -13765,7 +13849,7 @@ Gets an organizations basic details by org ID.
|
|
|
13765
13849
|
<dd>
|
|
13766
13850
|
|
|
13767
13851
|
```ruby
|
|
13768
|
-
client.organization.get_basic_organization_by_id(org_id: 123)
|
|
13852
|
+
client.organization.get_basic_organization_by_id(org_id: 123)
|
|
13769
13853
|
```
|
|
13770
13854
|
</dd>
|
|
13771
13855
|
</dl>
|
|
@@ -13827,7 +13911,7 @@ Retrieves details for an organization by ID.
|
|
|
13827
13911
|
<dd>
|
|
13828
13912
|
|
|
13829
13913
|
```ruby
|
|
13830
|
-
client.organization.get_organization(org_id: 123)
|
|
13914
|
+
client.organization.get_organization(org_id: 123)
|
|
13831
13915
|
```
|
|
13832
13916
|
</dd>
|
|
13833
13917
|
</dl>
|
|
@@ -13889,7 +13973,7 @@ Retrieves an organization's settings.
|
|
|
13889
13973
|
<dd>
|
|
13890
13974
|
|
|
13891
13975
|
```ruby
|
|
13892
|
-
client.organization.get_settings_organization(org_id: 123)
|
|
13976
|
+
client.organization.get_settings_organization(org_id: 123)
|
|
13893
13977
|
```
|
|
13894
13978
|
</dd>
|
|
13895
13979
|
</dl>
|
|
@@ -13954,26 +14038,26 @@ Generates a payment link for an invoice from the invoice ID.
|
|
|
13954
14038
|
```ruby
|
|
13955
14039
|
client.payment_link.add_pay_link_from_invoice(
|
|
13956
14040
|
id_invoice: 23548884,
|
|
13957
|
-
mail_2:
|
|
14041
|
+
mail_2: "jo@example.com; ceo@example.com",
|
|
13958
14042
|
contact_us: {
|
|
13959
|
-
email_label:
|
|
14043
|
+
email_label: "Email",
|
|
13960
14044
|
enabled: true,
|
|
13961
|
-
header:
|
|
14045
|
+
header: "Contact Us",
|
|
13962
14046
|
order: 0,
|
|
13963
14047
|
payment_icons: true,
|
|
13964
|
-
phone_label:
|
|
14048
|
+
phone_label: "Phone"
|
|
13965
14049
|
},
|
|
13966
14050
|
invoices: {
|
|
13967
14051
|
enabled: true,
|
|
13968
14052
|
invoice_link: {
|
|
13969
14053
|
enabled: true,
|
|
13970
|
-
label:
|
|
14054
|
+
label: "View Invoice",
|
|
13971
14055
|
order: 0
|
|
13972
14056
|
},
|
|
13973
14057
|
order: 0,
|
|
13974
14058
|
view_invoice_details: {
|
|
13975
14059
|
enabled: true,
|
|
13976
|
-
label:
|
|
14060
|
+
label: "Invoice Details",
|
|
13977
14061
|
order: 0
|
|
13978
14062
|
}
|
|
13979
14063
|
},
|
|
@@ -13983,31 +14067,31 @@ client.payment_link.add_pay_link_from_invoice(
|
|
|
13983
14067
|
},
|
|
13984
14068
|
message_before_paying: {
|
|
13985
14069
|
enabled: true,
|
|
13986
|
-
label:
|
|
14070
|
+
label: "Please review your payment details",
|
|
13987
14071
|
order: 0
|
|
13988
14072
|
},
|
|
13989
14073
|
notes: {
|
|
13990
14074
|
enabled: true,
|
|
13991
|
-
header:
|
|
14075
|
+
header: "Additional Notes",
|
|
13992
14076
|
order: 0,
|
|
13993
|
-
placeholder:
|
|
13994
|
-
value:
|
|
14077
|
+
placeholder: "Enter any additional notes here",
|
|
14078
|
+
value: ""
|
|
13995
14079
|
},
|
|
13996
14080
|
page: {
|
|
13997
|
-
description:
|
|
14081
|
+
description: "Complete your payment securely",
|
|
13998
14082
|
enabled: true,
|
|
13999
|
-
header:
|
|
14083
|
+
header: "Payment Page",
|
|
14000
14084
|
order: 0
|
|
14001
14085
|
},
|
|
14002
14086
|
payment_button: {
|
|
14003
14087
|
enabled: true,
|
|
14004
|
-
label:
|
|
14088
|
+
label: "Pay Now",
|
|
14005
14089
|
order: 0
|
|
14006
14090
|
},
|
|
14007
14091
|
payment_methods: {
|
|
14008
14092
|
all_methods_checked: true,
|
|
14009
14093
|
enabled: true,
|
|
14010
|
-
header:
|
|
14094
|
+
header: "Payment Methods",
|
|
14011
14095
|
methods: {
|
|
14012
14096
|
amex: true,
|
|
14013
14097
|
apple_pay: true,
|
|
@@ -14019,9 +14103,9 @@ client.payment_link.add_pay_link_from_invoice(
|
|
|
14019
14103
|
order: 0,
|
|
14020
14104
|
settings: {
|
|
14021
14105
|
apple_pay: {
|
|
14022
|
-
button_style:
|
|
14023
|
-
button_type:
|
|
14024
|
-
language:
|
|
14106
|
+
button_style: "black",
|
|
14107
|
+
button_type: "pay",
|
|
14108
|
+
language: "en-US"
|
|
14025
14109
|
}
|
|
14026
14110
|
}
|
|
14027
14111
|
},
|
|
@@ -14031,36 +14115,36 @@ client.payment_link.add_pay_link_from_invoice(
|
|
|
14031
14115
|
display: true,
|
|
14032
14116
|
fixed: true,
|
|
14033
14117
|
identifier: true,
|
|
14034
|
-
label:
|
|
14035
|
-
name:
|
|
14118
|
+
label: "Full Name",
|
|
14119
|
+
name: "fullName",
|
|
14036
14120
|
order: 0,
|
|
14037
14121
|
required: true,
|
|
14038
|
-
validation:
|
|
14039
|
-
value:
|
|
14122
|
+
validation: "alpha",
|
|
14123
|
+
value: "",
|
|
14040
14124
|
width: 0
|
|
14041
14125
|
}],
|
|
14042
|
-
header:
|
|
14126
|
+
header: "Payor Information",
|
|
14043
14127
|
order: 0
|
|
14044
14128
|
},
|
|
14045
14129
|
review: {
|
|
14046
14130
|
enabled: true,
|
|
14047
|
-
header:
|
|
14131
|
+
header: "Review Payment",
|
|
14048
14132
|
order: 0
|
|
14049
14133
|
},
|
|
14050
14134
|
settings: {
|
|
14051
14135
|
color: "#000000",
|
|
14052
|
-
custom_css_url:
|
|
14053
|
-
language:
|
|
14136
|
+
custom_css_url: "https://example.com/custom.css",
|
|
14137
|
+
language: "en",
|
|
14054
14138
|
page_logo: {
|
|
14055
|
-
f_content:
|
|
14056
|
-
filename:
|
|
14057
|
-
ftype:
|
|
14058
|
-
furl:
|
|
14139
|
+
f_content: "PHN2ZyB2aWV3Qm94PSIwIDAgODAwIDEwMDAiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+CiAgPCEtLSBCYWNrZ3JvdW5kIC0tPgogIDxyZWN0IHdpZHRoPSI4MDAiIGhlaWdodD0iMTAwMCIgZmlsbD0id2hpdGUiLz4KICAKICA8IS0tIENvbXBhbnkgSGVhZGVyIC0tPgogIDx0ZXh0IHg9IjQwIiB5PSI2MCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjI0IiBmb250LXdlaWdodD0iYm9sZCIgZmlsbD0iIzJjM2U1MCI+R3J1enlhIEFkdmVudHVyZSBPdXRmaXR0ZXJzPC90ZXh0PgogIDxsaW5lIHgxPSI0MCIgeTE9IjgwIiB4Mj0iNzYwIiB5Mj0iODAiIHN0cm9rZT0iIzJjM2U1MCIgc3Ryb2tlLXdpZHRoPSIyIi8+CiAgCiAgPCEtLSBDb21wYW55IERldGFpbHMgLS0+CiAgPHRleHQgeD0iNDAiIHk9IjExMCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE0IiBmaWxsPSIjMzQ0OTVlIj4xMjMgTW91bnRhaW4gVmlldyBSb2FkPC90ZXh0PgogIDx0ZXh0IHg9IjQwIiB5PSIxMzAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+VGJpbGlzaSwgR2VvcmdpYSAwMTA1PC90ZXh0PgogIDx0ZXh0IHg9IjQwIiB5PSIxNTAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+VGVsOiArOTk1IDMyIDEyMyA0NTY3PC90ZXh0PgogIDx0ZXh0IHg9IjQwIiB5PSIxNzAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+RW1haWw6IGluZm9AZ3J1enlhYWR2ZW50dXJlcy5jb208L3RleHQ+CgogIDwhLS0gSW52b2ljZSBUaXRsZSAtLT4KICA8dGV4dCB4PSI2MDAiIHk9IjExMCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjI0IiBmb250LXdlaWdodD0iYm9sZCIgZmlsbD0iIzJjM2U1MCI+SU5WT0lDRTwvdGV4dD4KICA8dGV4dCB4PSI2MDAiIHk9IjE0MCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE0IiBmaWxsPSIjMzQ0OTVlIj5EYXRlOiAxMi8xMS8yMDI0PC90ZXh0PgogIDx0ZXh0IHg9IjYwMCIgeT0iMTYwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZpbGw9IiMzNDQ5NWUiPkludm9pY2UgIzogR1JaLTIwMjQtMTEyMzwvdGV4dD4KCiAgPCEtLSBCaWxsIFRvIFNlY3Rpb24gLS0+CiAgPHRleHQgeD0iNDAiIHk9IjIyMCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE2IiBmb250LXdlaWdodD0iYm9sZCIgZmlsbD0iIzJjM2U1MCI+QklMTCBUTzo8L3RleHQ+CiAgPHJlY3QgeD0iNDAiIHk9IjIzNSIgd2lkdGg9IjMwMCIgaGVpZ2h0PSI4MCIgZmlsbD0iI2Y3ZjlmYSIvPgogIDx0ZXh0IHg9IjUwIiB5PSIyNjAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+W0N1c3RvbWVyIE5hbWVdPC90ZXh0PgogIDx0ZXh0IHg9IjUwIiB5PSIyODAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+W0FkZHJlc3MgTGluZSAxXTwvdGV4dD4KICA8dGV4dCB4PSI1MCIgeT0iMzAwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZpbGw9IiMzNDQ5NWUiPltDaXR5LCBDb3VudHJ5XTwvdGV4dD4KCiAgPCEtLSBUYWJsZSBIZWFkZXJzIC0tPgogIDxyZWN0IHg9IjQwIiB5PSIzNDAiIHdpZHRoPSI3MjAiIGhlaWdodD0iMzAiIGZpbGw9IiMyYzNlNTAiLz4KICA8dGV4dCB4PSI1MCIgeT0iMzYwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZvbnQtd2VpZ2h0PSJib2xkIiBmaWxsPSJ3aGl0ZSI+RGVzY3JpcHRpb248L3RleHQ+CiAgPHRleHQgeD0iNDUwIiB5PSIzNjAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZm9udC13ZWlnaHQ9ImJvbGQiIGZpbGw9IndoaXRlIj5RdWFudGl0eTwvdGV4dD4KICA8dGV4dCB4PSI1NTAiIHk9IjM2MCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE0IiBmb250LXdlaWdodD0iYm9sZCIgZmlsbD0id2hpdGUiPlJhdGU8L3RleHQ+CiAgPHRleHQgeD0iNjgwIiB5PSIzNjAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZm9udC13ZWlnaHQ9ImJvbGQiIGZpbGw9IndoaXRlIj5BbW91bnQ8L3RleHQ+CgogIDwhLS0gVGFibGUgUm93cyAtLT4KICA8cmVjdCB4PSI0MCIgeT0iMzcwIiB3aWR0aD0iNzIwIiBoZWlnaHQ9IjMwIiBmaWxsPSIjZjdmOWZhIi8+CiAgPHRleHQgeD0iNTAiIHk9IjM5MCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE0IiBmaWxsPSIjMzQ0OTVlIj5Nb3VudGFpbiBDbGltYmluZyBFcXVpcG1lbnQgUmVudGFsPC90ZXh0PgogIDx0ZXh0IHg9IjQ1MCIgeT0iMzkwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZpbGw9IiMzNDQ5NWUiPjE8L3RleHQ+CiAgPHRleHQgeD0iNTUwIiB5PSIzOTAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+JDI1MC4wMDwvdGV4dD4KICA8dGV4dCB4PSI2ODAiIHk9IjM5MCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE0IiBmaWxsPSIjMzQ0OTVlIj4kMjUwLjAwPC90ZXh0PgoKICA8cmVjdCB4PSI0MCIgeT0iNDAwIiB3aWR0aD0iNzIwIiBoZWlnaHQ9IjMwIiBmaWxsPSJ3aGl0ZSIvPgogIDx0ZXh0IHg9IjUwIiB5PSI0MjAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+R3VpZGVkIFRyZWsgUGFja2FnZSAtIDIgRGF5czwvdGV4dD4KICA8dGV4dCB4PSI0NTAiIHk9IjQyMCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE0IiBmaWxsPSIjMzQ0OTVlIj4xPC90ZXh0PgogIDx0ZXh0IHg9IjU1MCIgeT0iNDIwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZpbGw9IiMzNDQ5NWUiPiQ0MDAuMDA8L3RleHQ+CiAgPHRleHQgeD0iNjgwIiB5PSI0MjAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+JDQwMC4wMDwvdGV4dD4KCiAgPHJlY3QgeD0iNDAiIHk9IjQzMCIgd2lkdGg9IjcyMCIgaGVpZ2h0PSIzMCIgZmlsbD0iI2Y3ZjlmYSIvPgogIDx0ZXh0IHg9IjUwIiB5PSI0NTAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+U2FmZXR5IEVxdWlwbWVudCBQYWNrYWdlPC90ZXh0PgogIDx0ZXh0IHg9IjQ1MCIgeT0iNDUwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZpbGw9IiMzNDQ5NWUiPjE8L3RleHQ+CiAgPHRleHQgeD0iNTUwIiB5PSI0NTAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+JDE1MC4wMDwvdGV4dD4KICA8dGV4dCB4PSI2ODAiIHk9IjQ1MCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE0IiBmaWxsPSIjMzQ0OTVlIj4kMTUwLjAwPC90ZXh0PgoKICA8IS0tIFRvdGFscyAtLT4KICA8bGluZSB4MT0iNDAiIHkxPSI0ODAiIHgyPSI3NjAiIHkyPSI0ODAiIHN0cm9rZT0iIzJjM2U1MCIgc3Ryb2tlLXdpZHRoPSIxIi8+CiAgPHRleHQgeD0iNTUwIiB5PSI1MTAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZm9udC13ZWlnaHQ9ImJvbGQiIGZpbGw9IiMzNDQ5NWUiPlN1YnRvdGFsOjwvdGV4dD4KICA8dGV4dCB4PSI2ODAiIHk9IjUxMCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE0IiBmaWxsPSIjMzQ0OTVlIj4kODAwLjAwPC90ZXh0PgogIDx0ZXh0IHg9IjU1MCIgeT0iNTM1IiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZvbnQtd2VpZ2h0PSJib2xkIiBmaWxsPSIjMzQ0OTVlIj5UYXggKDE4JSk6PC90ZXh0PgogIDx0ZXh0IHg9IjY4MCIgeT0iNTM1IiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZpbGw9IiMzNDQ5NWUiPiQxNDQuMDA8L3RleHQ+CiAgPHRleHQgeD0iNTUwIiB5PSI1NzAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNiIgZm9udC13ZWlnaHQ9ImJvbGQiIGZpbGw9IiMyYzNlNTAiPlRvdGFsOjwvdGV4dD4KICA8dGV4dCB4PSI2ODAiIHk9IjU3MCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE2IiBmb250LXdlaWdodD0iYm9sZCIgZmlsbD0iIzJjM2U1MCI+JDk0NC4wMDwvdGV4dD4KCiAgPCEtLSBQYXltZW50IFRlcm1zIC0tPgogIDx0ZXh0IHg9IjQwIiB5PSI2NDAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNiIgZm9udC13ZWlnaHQ9ImJvbGQiIGZpbGw9IiMyYzNlNTAiPlBheW1lbnQgVGVybXM8L3RleHQ+CiAgPHRleHQgeD0iNDAiIHk9IjY3MCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjE0IiBmaWxsPSIjMzQ0OTVlIj5QYXltZW50IGlzIGR1ZSB3aXRoaW4gMzAgZGF5czwvdGV4dD4KICA8dGV4dCB4PSI0MCIgeT0iNjkwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZpbGw9IiMzNDQ5NWUiPlBsZWFzZSBpbmNsdWRlIGludm9pY2UgbnVtYmVyIG9uIHBheW1lbnQ8L3RleHQ+CgogIDwhLS0gQmFuayBEZXRhaWxzIC0tPgogIDx0ZXh0IHg9IjQwIiB5PSI3MzAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNiIgZm9udC13ZWlnaHQ9ImJvbGQiIGZpbGw9IiMyYzNlNTAiPkJhbmsgRGV0YWlsczwvdGV4dD4KICA8dGV4dCB4PSI0MCIgeT0iNzYwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZpbGw9IiMzNDQ5NWUiPkJhbms6IEJhbmsgb2YgR2VvcmdpYTwvdGV4dD4KICA8dGV4dCB4PSI0MCIgeT0iNzgwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTQiIGZpbGw9IiMzNDQ5NWUiPklCQU46IEdFMTIzNDU2Nzg5MDEyMzQ1Njc4PC90ZXh0PgogIDx0ZXh0IHg9IjQwIiB5PSI4MDAiIGZvbnQtZmFtaWx5PSJBcmlhbCIgZm9udC1zaXplPSIxNCIgZmlsbD0iIzM0NDk1ZSI+U1dJRlQ6IEJBR0FHRTIyPC90ZXh0PgoKICA8IS0tIEZvb3RlciAtLT4KICA8bGluZSB4MT0iNDAiIHkxPSI5MDAiIHgyPSI3NjAiIHkyPSI5MDAiIHN0cm9rZT0iIzJjM2U1MCIgc3Ryb2tlLXdpZHRoPSIxIi8+CiAgPHRleHQgeD0iNDAiIHk9IjkzMCIgZm9udC1mYW1pbHk9IkFyaWFsIiBmb250LXNpemU9IjEyIiBmaWxsPSIjN2Y4YzhkIj5UaGFuayB5b3UgZm9yIGNob29zaW5nIEdydXp5YSBBZHZlbnR1cmUgT3V0Zml0dGVyczwvdGV4dD4KICA8dGV4dCB4PSI0MCIgeT0iOTUwIiBmb250LWZhbWlseT0iQXJpYWwiIGZvbnQtc2l6ZT0iMTIiIGZpbGw9IiM3ZjhjOGQiPnd3dy5ncnV6eWFhZHZlbnR1cmVzLmNvbTwvdGV4dD4KPC9zdmc+Cg==",
|
|
14140
|
+
filename: "logo.jpg",
|
|
14141
|
+
ftype: "jpg",
|
|
14142
|
+
furl: ""
|
|
14059
14143
|
},
|
|
14060
14144
|
redirect_after_approve: true,
|
|
14061
|
-
redirect_after_approve_url:
|
|
14145
|
+
redirect_after_approve_url: "https://example.com/success"
|
|
14062
14146
|
}
|
|
14063
|
-
)
|
|
14147
|
+
)
|
|
14064
14148
|
```
|
|
14065
14149
|
</dd>
|
|
14066
14150
|
</dl>
|
|
@@ -14156,14 +14240,14 @@ Generates a payment link for a bill from the bill ID.
|
|
|
14156
14240
|
```ruby
|
|
14157
14241
|
client.payment_link.add_pay_link_from_bill(
|
|
14158
14242
|
bill_id: 23548884,
|
|
14159
|
-
mail_2:
|
|
14243
|
+
mail_2: "jo@example.com; ceo@example.com",
|
|
14160
14244
|
contact_us: {
|
|
14161
|
-
email_label:
|
|
14245
|
+
email_label: "Email",
|
|
14162
14246
|
enabled: true,
|
|
14163
|
-
header:
|
|
14247
|
+
header: "Contact Us",
|
|
14164
14248
|
order: 0,
|
|
14165
14249
|
payment_icons: true,
|
|
14166
|
-
phone_label:
|
|
14250
|
+
phone_label: "Phone"
|
|
14167
14251
|
},
|
|
14168
14252
|
logo: {
|
|
14169
14253
|
enabled: true,
|
|
@@ -14171,31 +14255,31 @@ client.payment_link.add_pay_link_from_bill(
|
|
|
14171
14255
|
},
|
|
14172
14256
|
message_before_paying: {
|
|
14173
14257
|
enabled: true,
|
|
14174
|
-
label:
|
|
14258
|
+
label: "Please review your payment details",
|
|
14175
14259
|
order: 0
|
|
14176
14260
|
},
|
|
14177
14261
|
notes: {
|
|
14178
14262
|
enabled: true,
|
|
14179
|
-
header:
|
|
14263
|
+
header: "Additional Notes",
|
|
14180
14264
|
order: 0,
|
|
14181
|
-
placeholder:
|
|
14182
|
-
value:
|
|
14265
|
+
placeholder: "Enter any additional notes here",
|
|
14266
|
+
value: ""
|
|
14183
14267
|
},
|
|
14184
14268
|
page: {
|
|
14185
|
-
description:
|
|
14269
|
+
description: "Get paid securely",
|
|
14186
14270
|
enabled: true,
|
|
14187
|
-
header:
|
|
14271
|
+
header: "Payment Page",
|
|
14188
14272
|
order: 0
|
|
14189
14273
|
},
|
|
14190
14274
|
payment_button: {
|
|
14191
14275
|
enabled: true,
|
|
14192
|
-
label:
|
|
14276
|
+
label: "Pay Now",
|
|
14193
14277
|
order: 0
|
|
14194
14278
|
},
|
|
14195
14279
|
payment_methods: {
|
|
14196
14280
|
all_methods_checked: true,
|
|
14197
14281
|
enabled: true,
|
|
14198
|
-
header:
|
|
14282
|
+
header: "Payment Methods",
|
|
14199
14283
|
methods: {
|
|
14200
14284
|
amex: true,
|
|
14201
14285
|
apple_pay: true,
|
|
@@ -14212,27 +14296,27 @@ client.payment_link.add_pay_link_from_bill(
|
|
|
14212
14296
|
display: true,
|
|
14213
14297
|
fixed: true,
|
|
14214
14298
|
identifier: true,
|
|
14215
|
-
label:
|
|
14216
|
-
name:
|
|
14299
|
+
label: "Full Name",
|
|
14300
|
+
name: "fullName",
|
|
14217
14301
|
order: 0,
|
|
14218
14302
|
required: true,
|
|
14219
|
-
validation:
|
|
14220
|
-
value:
|
|
14303
|
+
validation: "alpha",
|
|
14304
|
+
value: "",
|
|
14221
14305
|
width: 0
|
|
14222
14306
|
}],
|
|
14223
|
-
header:
|
|
14307
|
+
header: "Payor Information",
|
|
14224
14308
|
order: 0
|
|
14225
14309
|
},
|
|
14226
14310
|
review: {
|
|
14227
14311
|
enabled: true,
|
|
14228
|
-
header:
|
|
14312
|
+
header: "Review Payment",
|
|
14229
14313
|
order: 0
|
|
14230
14314
|
},
|
|
14231
14315
|
settings: {
|
|
14232
14316
|
color: "#000000",
|
|
14233
|
-
language:
|
|
14317
|
+
language: "en"
|
|
14234
14318
|
}
|
|
14235
|
-
)
|
|
14319
|
+
)
|
|
14236
14320
|
```
|
|
14237
14321
|
</dd>
|
|
14238
14322
|
</dl>
|
|
@@ -14326,7 +14410,7 @@ Deletes a payment link by ID.
|
|
|
14326
14410
|
<dd>
|
|
14327
14411
|
|
|
14328
14412
|
```ruby
|
|
14329
|
-
client.payment_link.delete_pay_link_from_id(pay_link_id:
|
|
14413
|
+
client.payment_link.delete_pay_link_from_id(pay_link_id: "payLinkId")
|
|
14330
14414
|
```
|
|
14331
14415
|
</dd>
|
|
14332
14416
|
</dl>
|
|
@@ -14388,7 +14472,7 @@ Retrieves a payment link by ID.
|
|
|
14388
14472
|
<dd>
|
|
14389
14473
|
|
|
14390
14474
|
```ruby
|
|
14391
|
-
client.payment_link.get_pay_link_from_id(paylink_id:
|
|
14475
|
+
client.payment_link.get_pay_link_from_id(paylink_id: "paylinkId")
|
|
14392
14476
|
```
|
|
14393
14477
|
</dd>
|
|
14394
14478
|
</dl>
|
|
@@ -14450,7 +14534,7 @@ Send a payment link to the specified email addresses or phone numbers.
|
|
|
14450
14534
|
<dd>
|
|
14451
14535
|
|
|
14452
14536
|
```ruby
|
|
14453
|
-
client.payment_link.push_pay_link_from_id(pay_link_id:
|
|
14537
|
+
client.payment_link.push_pay_link_from_id(pay_link_id: "payLinkId")
|
|
14454
14538
|
```
|
|
14455
14539
|
</dd>
|
|
14456
14540
|
</dl>
|
|
@@ -14520,7 +14604,7 @@ Refresh a payment link's content after an update.
|
|
|
14520
14604
|
<dd>
|
|
14521
14605
|
|
|
14522
14606
|
```ruby
|
|
14523
|
-
client.payment_link.refresh_pay_link_from_id(pay_link_id:
|
|
14607
|
+
client.payment_link.refresh_pay_link_from_id(pay_link_id: "payLinkId")
|
|
14524
14608
|
```
|
|
14525
14609
|
</dd>
|
|
14526
14610
|
</dl>
|
|
@@ -14591,9 +14675,9 @@ Sends a payment link to the specified email addresses.
|
|
|
14591
14675
|
|
|
14592
14676
|
```ruby
|
|
14593
14677
|
client.payment_link.send_pay_link_from_id(
|
|
14594
|
-
pay_link_id:
|
|
14595
|
-
mail_2:
|
|
14596
|
-
)
|
|
14678
|
+
pay_link_id: "payLinkId",
|
|
14679
|
+
mail_2: "jo@example.com; ceo@example.com"
|
|
14680
|
+
)
|
|
14597
14681
|
```
|
|
14598
14682
|
</dd>
|
|
14599
14683
|
</dl>
|
|
@@ -14672,20 +14756,20 @@ Updates a payment link's details.
|
|
|
14672
14756
|
|
|
14673
14757
|
```ruby
|
|
14674
14758
|
client.payment_link.update_pay_link_from_id(
|
|
14675
|
-
pay_link_id:
|
|
14759
|
+
pay_link_id: "332-c277b704-1301",
|
|
14676
14760
|
notes: {
|
|
14677
14761
|
enabled: true,
|
|
14678
|
-
header:
|
|
14762
|
+
header: "Additional Notes",
|
|
14679
14763
|
order: 0,
|
|
14680
|
-
placeholder:
|
|
14681
|
-
value:
|
|
14764
|
+
placeholder: "Enter any additional notes here",
|
|
14765
|
+
value: ""
|
|
14682
14766
|
},
|
|
14683
14767
|
payment_button: {
|
|
14684
14768
|
enabled: true,
|
|
14685
|
-
label:
|
|
14769
|
+
label: "Pay Now",
|
|
14686
14770
|
order: 0
|
|
14687
14771
|
}
|
|
14688
|
-
)
|
|
14772
|
+
)
|
|
14689
14773
|
```
|
|
14690
14774
|
</dd>
|
|
14691
14775
|
</dl>
|
|
@@ -14820,18 +14904,18 @@ Generates a vendor payment link for a specific bill lot number. This allows you
|
|
|
14820
14904
|
|
|
14821
14905
|
```ruby
|
|
14822
14906
|
client.payment_link.add_pay_link_from_bill_lot_number(
|
|
14823
|
-
lot_number:
|
|
14824
|
-
entry_point:
|
|
14825
|
-
vendor_number:
|
|
14826
|
-
mail_2:
|
|
14827
|
-
amount_fixed:
|
|
14907
|
+
lot_number: "LOT-2024-001",
|
|
14908
|
+
entry_point: "billing",
|
|
14909
|
+
vendor_number: "VENDOR-123",
|
|
14910
|
+
mail_2: "customer@example.com; billing@example.com",
|
|
14911
|
+
amount_fixed: "true",
|
|
14828
14912
|
contact_us: {
|
|
14829
|
-
email_label:
|
|
14913
|
+
email_label: "Email",
|
|
14830
14914
|
enabled: true,
|
|
14831
|
-
header:
|
|
14915
|
+
header: "Contact Us",
|
|
14832
14916
|
order: 0,
|
|
14833
14917
|
payment_icons: true,
|
|
14834
|
-
phone_label:
|
|
14918
|
+
phone_label: "Phone"
|
|
14835
14919
|
},
|
|
14836
14920
|
logo: {
|
|
14837
14921
|
enabled: true,
|
|
@@ -14839,31 +14923,31 @@ client.payment_link.add_pay_link_from_bill_lot_number(
|
|
|
14839
14923
|
},
|
|
14840
14924
|
message_before_paying: {
|
|
14841
14925
|
enabled: true,
|
|
14842
|
-
label:
|
|
14926
|
+
label: "Please review your payment details",
|
|
14843
14927
|
order: 0
|
|
14844
14928
|
},
|
|
14845
14929
|
notes: {
|
|
14846
14930
|
enabled: true,
|
|
14847
|
-
header:
|
|
14931
|
+
header: "Additional Notes",
|
|
14848
14932
|
order: 0,
|
|
14849
|
-
placeholder:
|
|
14850
|
-
value:
|
|
14933
|
+
placeholder: "Enter any additional notes here",
|
|
14934
|
+
value: ""
|
|
14851
14935
|
},
|
|
14852
14936
|
page: {
|
|
14853
|
-
description:
|
|
14937
|
+
description: "Get paid securely",
|
|
14854
14938
|
enabled: true,
|
|
14855
|
-
header:
|
|
14939
|
+
header: "Payment Page",
|
|
14856
14940
|
order: 0
|
|
14857
14941
|
},
|
|
14858
14942
|
payment_button: {
|
|
14859
14943
|
enabled: true,
|
|
14860
|
-
label:
|
|
14944
|
+
label: "Pay Now",
|
|
14861
14945
|
order: 0
|
|
14862
14946
|
},
|
|
14863
14947
|
payment_methods: {
|
|
14864
14948
|
all_methods_checked: true,
|
|
14865
14949
|
enabled: true,
|
|
14866
|
-
header:
|
|
14950
|
+
header: "Payment Methods",
|
|
14867
14951
|
methods: {
|
|
14868
14952
|
amex: true,
|
|
14869
14953
|
apple_pay: true,
|
|
@@ -14880,27 +14964,27 @@ client.payment_link.add_pay_link_from_bill_lot_number(
|
|
|
14880
14964
|
display: true,
|
|
14881
14965
|
fixed: true,
|
|
14882
14966
|
identifier: true,
|
|
14883
|
-
label:
|
|
14884
|
-
name:
|
|
14967
|
+
label: "Full Name",
|
|
14968
|
+
name: "fullName",
|
|
14885
14969
|
order: 0,
|
|
14886
14970
|
required: true,
|
|
14887
|
-
validation:
|
|
14888
|
-
value:
|
|
14971
|
+
validation: "alpha",
|
|
14972
|
+
value: "",
|
|
14889
14973
|
width: 0
|
|
14890
14974
|
}],
|
|
14891
|
-
header:
|
|
14975
|
+
header: "Payor Information",
|
|
14892
14976
|
order: 0
|
|
14893
14977
|
},
|
|
14894
14978
|
review: {
|
|
14895
14979
|
enabled: true,
|
|
14896
|
-
header:
|
|
14980
|
+
header: "Review Payment",
|
|
14897
14981
|
order: 0
|
|
14898
14982
|
},
|
|
14899
14983
|
settings: {
|
|
14900
14984
|
color: "#000000",
|
|
14901
|
-
language:
|
|
14985
|
+
language: "en"
|
|
14902
14986
|
}
|
|
14903
|
-
)
|
|
14987
|
+
)
|
|
14904
14988
|
```
|
|
14905
14989
|
</dd>
|
|
14906
14990
|
</dl>
|
|
@@ -15004,16 +15088,16 @@ Add a payment method domain to an organization or paypoint.
|
|
|
15004
15088
|
|
|
15005
15089
|
```ruby
|
|
15006
15090
|
client.payment_method_domain.add_payment_method_domain(
|
|
15007
|
-
domain_name:
|
|
15091
|
+
domain_name: "checkout.example.com",
|
|
15008
15092
|
entity_id: 109,
|
|
15009
|
-
entity_type:
|
|
15093
|
+
entity_type: "paypoint",
|
|
15010
15094
|
apple_pay: {
|
|
15011
15095
|
is_enabled: true
|
|
15012
15096
|
},
|
|
15013
15097
|
google_pay: {
|
|
15014
15098
|
is_enabled: true
|
|
15015
15099
|
}
|
|
15016
|
-
)
|
|
15100
|
+
)
|
|
15017
15101
|
```
|
|
15018
15102
|
</dd>
|
|
15019
15103
|
</dl>
|
|
@@ -15107,7 +15191,7 @@ Cascades a payment method domain to all child entities. All paypoints and suborg
|
|
|
15107
15191
|
<dd>
|
|
15108
15192
|
|
|
15109
15193
|
```ruby
|
|
15110
|
-
client.payment_method_domain.cascade_payment_method_domain(domain_id:
|
|
15194
|
+
client.payment_method_domain.cascade_payment_method_domain(domain_id: "pmd_b8237fa45c964d8a9ef27160cd42b8c5")
|
|
15111
15195
|
```
|
|
15112
15196
|
</dd>
|
|
15113
15197
|
</dl>
|
|
@@ -15169,7 +15253,7 @@ Delete a payment method domain. You can't delete an inherited domain, you must d
|
|
|
15169
15253
|
<dd>
|
|
15170
15254
|
|
|
15171
15255
|
```ruby
|
|
15172
|
-
client.payment_method_domain.delete_payment_method_domain(domain_id:
|
|
15256
|
+
client.payment_method_domain.delete_payment_method_domain(domain_id: "pmd_b8237fa45c964d8a9ef27160cd42b8c5")
|
|
15173
15257
|
```
|
|
15174
15258
|
</dd>
|
|
15175
15259
|
</dl>
|
|
@@ -15231,7 +15315,7 @@ Get the details for a payment method domain.
|
|
|
15231
15315
|
<dd>
|
|
15232
15316
|
|
|
15233
15317
|
```ruby
|
|
15234
|
-
client.payment_method_domain.get_payment_method_domain(domain_id:
|
|
15318
|
+
client.payment_method_domain.get_payment_method_domain(domain_id: "pmd_b8237fa45c964d8a9ef27160cd42b8c5")
|
|
15235
15319
|
```
|
|
15236
15320
|
</dd>
|
|
15237
15321
|
</dl>
|
|
@@ -15295,8 +15379,8 @@ Get a list of payment method domains that belong to a PSP, organization, or payp
|
|
|
15295
15379
|
```ruby
|
|
15296
15380
|
client.payment_method_domain.list_payment_method_domains(
|
|
15297
15381
|
entity_id: 1147,
|
|
15298
|
-
entity_type:
|
|
15299
|
-
)
|
|
15382
|
+
entity_type: "paypoint"
|
|
15383
|
+
)
|
|
15300
15384
|
```
|
|
15301
15385
|
</dd>
|
|
15302
15386
|
</dl>
|
|
@@ -15391,14 +15475,14 @@ Update a payment method domain's configuration values.
|
|
|
15391
15475
|
|
|
15392
15476
|
```ruby
|
|
15393
15477
|
client.payment_method_domain.update_payment_method_domain(
|
|
15394
|
-
domain_id:
|
|
15478
|
+
domain_id: "pmd_b8237fa45c964d8a9ef27160cd42b8c5",
|
|
15395
15479
|
apple_pay: {
|
|
15396
15480
|
is_enabled: false
|
|
15397
15481
|
},
|
|
15398
15482
|
google_pay: {
|
|
15399
15483
|
is_enabled: false
|
|
15400
15484
|
}
|
|
15401
|
-
)
|
|
15485
|
+
)
|
|
15402
15486
|
```
|
|
15403
15487
|
</dd>
|
|
15404
15488
|
</dl>
|
|
@@ -15476,7 +15560,7 @@ Verify a new payment method domain. If verification is successful, Apple Pay is
|
|
|
15476
15560
|
<dd>
|
|
15477
15561
|
|
|
15478
15562
|
```ruby
|
|
15479
|
-
client.payment_method_domain.verify_payment_method_domain(domain_id:
|
|
15563
|
+
client.payment_method_domain.verify_payment_method_domain(domain_id: "pmd_b8237fa45c964d8a9ef27160cd42b8c5")
|
|
15480
15564
|
```
|
|
15481
15565
|
</dd>
|
|
15482
15566
|
</dl>
|
|
@@ -15539,7 +15623,7 @@ Gets the basic details for a paypoint.
|
|
|
15539
15623
|
<dd>
|
|
15540
15624
|
|
|
15541
15625
|
```ruby
|
|
15542
|
-
client.paypoint.get_basic_entry(entry:
|
|
15626
|
+
client.paypoint.get_basic_entry(entry: "8cfec329267")
|
|
15543
15627
|
```
|
|
15544
15628
|
</dd>
|
|
15545
15629
|
</dl>
|
|
@@ -15601,7 +15685,7 @@ Retrieves the basic details for a paypoint by ID.
|
|
|
15601
15685
|
<dd>
|
|
15602
15686
|
|
|
15603
15687
|
```ruby
|
|
15604
|
-
client.paypoint.get_basic_entry_by_id(id_paypoint:
|
|
15688
|
+
client.paypoint.get_basic_entry_by_id(id_paypoint: "198")
|
|
15605
15689
|
```
|
|
15606
15690
|
</dd>
|
|
15607
15691
|
</dl>
|
|
@@ -15663,7 +15747,7 @@ Gets the details for a single paypoint.
|
|
|
15663
15747
|
<dd>
|
|
15664
15748
|
|
|
15665
15749
|
```ruby
|
|
15666
|
-
client.paypoint.get_entry_config(entry:
|
|
15750
|
+
client.paypoint.get_entry_config(entry: "8cfec329267")
|
|
15667
15751
|
```
|
|
15668
15752
|
</dd>
|
|
15669
15753
|
</dl>
|
|
@@ -15734,9 +15818,9 @@ Gets the details for single payment page for a paypoint.
|
|
|
15734
15818
|
|
|
15735
15819
|
```ruby
|
|
15736
15820
|
client.paypoint.get_page(
|
|
15737
|
-
entry:
|
|
15738
|
-
subdomain:
|
|
15739
|
-
)
|
|
15821
|
+
entry: "8cfec329267",
|
|
15822
|
+
subdomain: "pay-your-fees-1"
|
|
15823
|
+
)
|
|
15740
15824
|
```
|
|
15741
15825
|
</dd>
|
|
15742
15826
|
</dl>
|
|
@@ -15807,9 +15891,9 @@ Deletes a payment page in a paypoint.
|
|
|
15807
15891
|
|
|
15808
15892
|
```ruby
|
|
15809
15893
|
client.paypoint.remove_page(
|
|
15810
|
-
entry:
|
|
15811
|
-
subdomain:
|
|
15812
|
-
)
|
|
15894
|
+
entry: "8cfec329267",
|
|
15895
|
+
subdomain: "pay-your-fees-1"
|
|
15896
|
+
)
|
|
15813
15897
|
```
|
|
15814
15898
|
</dd>
|
|
15815
15899
|
</dl>
|
|
@@ -15879,7 +15963,7 @@ Updates a paypoint logo.
|
|
|
15879
15963
|
<dd>
|
|
15880
15964
|
|
|
15881
15965
|
```ruby
|
|
15882
|
-
client.paypoint.save_logo(entry:
|
|
15966
|
+
client.paypoint.save_logo(entry: "8cfec329267")
|
|
15883
15967
|
```
|
|
15884
15968
|
</dd>
|
|
15885
15969
|
</dl>
|
|
@@ -15949,7 +16033,7 @@ Retrieves an paypoint's basic settings like custom fields, identifiers, and invo
|
|
|
15949
16033
|
<dd>
|
|
15950
16034
|
|
|
15951
16035
|
```ruby
|
|
15952
|
-
client.paypoint.settings_page(entry:
|
|
16036
|
+
client.paypoint.settings_page(entry: "8cfec329267")
|
|
15953
16037
|
```
|
|
15954
16038
|
</dd>
|
|
15955
16039
|
</dl>
|
|
@@ -16012,16 +16096,16 @@ Migrates a paypoint to a new parent organization.
|
|
|
16012
16096
|
|
|
16013
16097
|
```ruby
|
|
16014
16098
|
client.paypoint.migrate(
|
|
16015
|
-
entry_point:
|
|
16099
|
+
entry_point: "473abc123def",
|
|
16016
16100
|
new_parent_organization_id: 123,
|
|
16017
16101
|
notification_request: {
|
|
16018
|
-
notification_url:
|
|
16102
|
+
notification_url: "https://webhook-test.yoursie.com",
|
|
16019
16103
|
web_header_parameters: [{
|
|
16020
|
-
key:
|
|
16021
|
-
value:
|
|
16104
|
+
key: "testheader",
|
|
16105
|
+
value: "1234567890"
|
|
16022
16106
|
}]
|
|
16023
16107
|
}
|
|
16024
|
-
)
|
|
16108
|
+
)
|
|
16025
16109
|
```
|
|
16026
16110
|
</dd>
|
|
16027
16111
|
</dl>
|
|
@@ -16086,11 +16170,11 @@ unsettled transactions for a paypoint. Use filters to limit results. Include the
|
|
|
16086
16170
|
|
|
16087
16171
|
```ruby
|
|
16088
16172
|
client.query.list_batch_details(
|
|
16089
|
-
entry:
|
|
16173
|
+
entry: "8cfec329267",
|
|
16090
16174
|
from_record: 251,
|
|
16091
16175
|
limit_record: 0,
|
|
16092
|
-
sort_by:
|
|
16093
|
-
)
|
|
16176
|
+
sort_by: "desc(field_name)"
|
|
16177
|
+
)
|
|
16094
16178
|
```
|
|
16095
16179
|
</dd>
|
|
16096
16180
|
</dl>
|
|
@@ -16273,8 +16357,8 @@ client.query.list_batch_details_org(
|
|
|
16273
16357
|
org_id: 123,
|
|
16274
16358
|
from_record: 251,
|
|
16275
16359
|
limit_record: 0,
|
|
16276
|
-
sort_by:
|
|
16277
|
-
)
|
|
16360
|
+
sort_by: "desc(field_name)"
|
|
16361
|
+
)
|
|
16278
16362
|
```
|
|
16279
16363
|
</dd>
|
|
16280
16364
|
</dl>
|
|
@@ -16453,11 +16537,11 @@ Retrieve a list of batches for a paypoint. Use filters to limit results. Include
|
|
|
16453
16537
|
|
|
16454
16538
|
```ruby
|
|
16455
16539
|
client.query.list_batches(
|
|
16456
|
-
entry:
|
|
16540
|
+
entry: "8cfec329267",
|
|
16457
16541
|
from_record: 251,
|
|
16458
16542
|
limit_record: 0,
|
|
16459
|
-
sort_by:
|
|
16460
|
-
)
|
|
16543
|
+
sort_by: "desc(field_name)"
|
|
16544
|
+
)
|
|
16461
16545
|
```
|
|
16462
16546
|
</dd>
|
|
16463
16547
|
</dl>
|
|
@@ -16618,8 +16702,8 @@ client.query.list_batches_org(
|
|
|
16618
16702
|
org_id: 123,
|
|
16619
16703
|
from_record: 251,
|
|
16620
16704
|
limit_record: 0,
|
|
16621
|
-
sort_by:
|
|
16622
|
-
)
|
|
16705
|
+
sort_by: "desc(field_name)"
|
|
16706
|
+
)
|
|
16623
16707
|
```
|
|
16624
16708
|
</dd>
|
|
16625
16709
|
</dl>
|
|
@@ -16777,11 +16861,11 @@ Retrieve a list of MoneyOut batches for a paypoint. Use filters to limit results
|
|
|
16777
16861
|
|
|
16778
16862
|
```ruby
|
|
16779
16863
|
client.query.list_batches_out(
|
|
16780
|
-
entry:
|
|
16864
|
+
entry: "8cfec329267",
|
|
16781
16865
|
from_record: 251,
|
|
16782
16866
|
limit_record: 0,
|
|
16783
|
-
sort_by:
|
|
16784
|
-
)
|
|
16867
|
+
sort_by: "desc(field_name)"
|
|
16868
|
+
)
|
|
16785
16869
|
```
|
|
16786
16870
|
</dd>
|
|
16787
16871
|
</dl>
|
|
@@ -16904,8 +16988,8 @@ client.query.list_batches_out_org(
|
|
|
16904
16988
|
org_id: 123,
|
|
16905
16989
|
from_record: 251,
|
|
16906
16990
|
limit_record: 0,
|
|
16907
|
-
sort_by:
|
|
16908
|
-
)
|
|
16991
|
+
sort_by: "desc(field_name)"
|
|
16992
|
+
)
|
|
16909
16993
|
```
|
|
16910
16994
|
</dd>
|
|
16911
16995
|
</dl>
|
|
@@ -17040,11 +17124,11 @@ Retrieves a list of chargebacks and returned transactions for a paypoint. Use fi
|
|
|
17040
17124
|
|
|
17041
17125
|
```ruby
|
|
17042
17126
|
client.query.list_chargebacks(
|
|
17043
|
-
entry:
|
|
17127
|
+
entry: "8cfec329267",
|
|
17044
17128
|
from_record: 251,
|
|
17045
17129
|
limit_record: 0,
|
|
17046
|
-
sort_by:
|
|
17047
|
-
)
|
|
17130
|
+
sort_by: "desc(field_name)"
|
|
17131
|
+
)
|
|
17048
17132
|
```
|
|
17049
17133
|
</dd>
|
|
17050
17134
|
</dl>
|
|
@@ -17222,8 +17306,8 @@ client.query.list_chargebacks_org(
|
|
|
17222
17306
|
org_id: 123,
|
|
17223
17307
|
from_record: 251,
|
|
17224
17308
|
limit_record: 0,
|
|
17225
|
-
sort_by:
|
|
17226
|
-
)
|
|
17309
|
+
sort_by: "desc(field_name)"
|
|
17310
|
+
)
|
|
17227
17311
|
```
|
|
17228
17312
|
</dd>
|
|
17229
17313
|
</dl>
|
|
@@ -17400,11 +17484,11 @@ Retrieves a list of customers for a paypoint. Use filters to limit results. Incl
|
|
|
17400
17484
|
|
|
17401
17485
|
```ruby
|
|
17402
17486
|
client.query.list_customers(
|
|
17403
|
-
entry:
|
|
17487
|
+
entry: "8cfec329267",
|
|
17404
17488
|
from_record: 251,
|
|
17405
17489
|
limit_record: 0,
|
|
17406
|
-
sort_by:
|
|
17407
|
-
)
|
|
17490
|
+
sort_by: "desc(field_name)"
|
|
17491
|
+
)
|
|
17408
17492
|
```
|
|
17409
17493
|
</dd>
|
|
17410
17494
|
</dl>
|
|
@@ -17576,8 +17660,8 @@ client.query.list_customers_org(
|
|
|
17576
17660
|
org_id: 123,
|
|
17577
17661
|
from_record: 251,
|
|
17578
17662
|
limit_record: 0,
|
|
17579
|
-
sort_by:
|
|
17580
|
-
)
|
|
17663
|
+
sort_by: "desc(field_name)"
|
|
17664
|
+
)
|
|
17581
17665
|
```
|
|
17582
17666
|
</dd>
|
|
17583
17667
|
</dl>
|
|
@@ -17746,11 +17830,11 @@ Returns a list of all reports generated in the last 60 days for a single entrypo
|
|
|
17746
17830
|
|
|
17747
17831
|
```ruby
|
|
17748
17832
|
client.query.list_notification_reports(
|
|
17749
|
-
entry:
|
|
17833
|
+
entry: "8cfec329267",
|
|
17750
17834
|
from_record: 251,
|
|
17751
17835
|
limit_record: 0,
|
|
17752
|
-
sort_by:
|
|
17753
|
-
)
|
|
17836
|
+
sort_by: "desc(field_name)"
|
|
17837
|
+
)
|
|
17754
17838
|
```
|
|
17755
17839
|
</dd>
|
|
17756
17840
|
</dl>
|
|
@@ -17887,8 +17971,8 @@ client.query.list_notification_reports_org(
|
|
|
17887
17971
|
org_id: 123,
|
|
17888
17972
|
from_record: 251,
|
|
17889
17973
|
limit_record: 0,
|
|
17890
|
-
sort_by:
|
|
17891
|
-
)
|
|
17974
|
+
sort_by: "desc(field_name)"
|
|
17975
|
+
)
|
|
17892
17976
|
```
|
|
17893
17977
|
</dd>
|
|
17894
17978
|
</dl>
|
|
@@ -18020,11 +18104,11 @@ Returns a list of notifications for an entrypoint. Use filters to limit results.
|
|
|
18020
18104
|
|
|
18021
18105
|
```ruby
|
|
18022
18106
|
client.query.list_notifications(
|
|
18023
|
-
entry:
|
|
18107
|
+
entry: "8cfec329267",
|
|
18024
18108
|
from_record: 251,
|
|
18025
18109
|
limit_record: 0,
|
|
18026
|
-
sort_by:
|
|
18027
|
-
)
|
|
18110
|
+
sort_by: "desc(field_name)"
|
|
18111
|
+
)
|
|
18028
18112
|
```
|
|
18029
18113
|
</dd>
|
|
18030
18114
|
</dl>
|
|
@@ -18163,8 +18247,8 @@ client.query.list_notifications_org(
|
|
|
18163
18247
|
org_id: 123,
|
|
18164
18248
|
from_record: 251,
|
|
18165
18249
|
limit_record: 0,
|
|
18166
|
-
sort_by:
|
|
18167
|
-
)
|
|
18250
|
+
sort_by: "desc(field_name)"
|
|
18251
|
+
)
|
|
18168
18252
|
```
|
|
18169
18253
|
</dd>
|
|
18170
18254
|
</dl>
|
|
@@ -18303,8 +18387,8 @@ client.query.list_organizations(
|
|
|
18303
18387
|
org_id: 123,
|
|
18304
18388
|
from_record: 251,
|
|
18305
18389
|
limit_record: 0,
|
|
18306
|
-
sort_by:
|
|
18307
|
-
)
|
|
18390
|
+
sort_by: "desc(field_name)"
|
|
18391
|
+
)
|
|
18308
18392
|
```
|
|
18309
18393
|
</dd>
|
|
18310
18394
|
</dl>
|
|
@@ -18460,11 +18544,11 @@ Retrieves a list of money out transactions (payouts) for a paypoint. Use filters
|
|
|
18460
18544
|
|
|
18461
18545
|
```ruby
|
|
18462
18546
|
client.query.list_payout(
|
|
18463
|
-
entry:
|
|
18547
|
+
entry: "8cfec329267",
|
|
18464
18548
|
from_record: 251,
|
|
18465
18549
|
limit_record: 0,
|
|
18466
|
-
sort_by:
|
|
18467
|
-
)
|
|
18550
|
+
sort_by: "desc(field_name)"
|
|
18551
|
+
)
|
|
18468
18552
|
```
|
|
18469
18553
|
</dd>
|
|
18470
18554
|
</dl>
|
|
@@ -18650,8 +18734,8 @@ client.query.list_payout_org(
|
|
|
18650
18734
|
org_id: 123,
|
|
18651
18735
|
from_record: 251,
|
|
18652
18736
|
limit_record: 0,
|
|
18653
|
-
sort_by:
|
|
18654
|
-
)
|
|
18737
|
+
sort_by: "desc(field_name)"
|
|
18738
|
+
)
|
|
18655
18739
|
```
|
|
18656
18740
|
</dd>
|
|
18657
18741
|
</dl>
|
|
@@ -18836,8 +18920,8 @@ client.query.list_paypoints(
|
|
|
18836
18920
|
org_id: 123,
|
|
18837
18921
|
from_record: 251,
|
|
18838
18922
|
limit_record: 0,
|
|
18839
|
-
sort_by:
|
|
18840
|
-
)
|
|
18923
|
+
sort_by: "desc(field_name)"
|
|
18924
|
+
)
|
|
18841
18925
|
```
|
|
18842
18926
|
</dd>
|
|
18843
18927
|
</dl>
|
|
@@ -18998,11 +19082,11 @@ Retrieve a list of settled transactions for a paypoint. Use filters to limit res
|
|
|
18998
19082
|
|
|
18999
19083
|
```ruby
|
|
19000
19084
|
client.query.list_settlements(
|
|
19001
|
-
entry:
|
|
19085
|
+
entry: "8cfec329267",
|
|
19002
19086
|
from_record: 251,
|
|
19003
19087
|
limit_record: 0,
|
|
19004
|
-
sort_by:
|
|
19005
|
-
)
|
|
19088
|
+
sort_by: "desc(field_name)"
|
|
19089
|
+
)
|
|
19006
19090
|
```
|
|
19007
19091
|
</dd>
|
|
19008
19092
|
</dl>
|
|
@@ -19185,8 +19269,8 @@ client.query.list_settlements_org(
|
|
|
19185
19269
|
org_id: 123,
|
|
19186
19270
|
from_record: 251,
|
|
19187
19271
|
limit_record: 0,
|
|
19188
|
-
sort_by:
|
|
19189
|
-
)
|
|
19272
|
+
sort_by: "desc(field_name)"
|
|
19273
|
+
)
|
|
19190
19274
|
```
|
|
19191
19275
|
</dd>
|
|
19192
19276
|
</dl>
|
|
@@ -19366,11 +19450,11 @@ Returns a list of subscriptions for a single paypoint. Use filters to limit resu
|
|
|
19366
19450
|
|
|
19367
19451
|
```ruby
|
|
19368
19452
|
client.query.list_subscriptions(
|
|
19369
|
-
entry:
|
|
19453
|
+
entry: "8cfec329267",
|
|
19370
19454
|
from_record: 251,
|
|
19371
19455
|
limit_record: 0,
|
|
19372
|
-
sort_by:
|
|
19373
|
-
)
|
|
19456
|
+
sort_by: "desc(field_name)"
|
|
19457
|
+
)
|
|
19374
19458
|
```
|
|
19375
19459
|
</dd>
|
|
19376
19460
|
</dl>
|
|
@@ -19553,8 +19637,8 @@ client.query.list_subscriptions_org(
|
|
|
19553
19637
|
org_id: 123,
|
|
19554
19638
|
from_record: 251,
|
|
19555
19639
|
limit_record: 0,
|
|
19556
|
-
sort_by:
|
|
19557
|
-
)
|
|
19640
|
+
sort_by: "desc(field_name)"
|
|
19641
|
+
)
|
|
19558
19642
|
```
|
|
19559
19643
|
</dd>
|
|
19560
19644
|
</dl>
|
|
@@ -19741,11 +19825,11 @@ For example, this request parameters filter for transactions between April 01, 2
|
|
|
19741
19825
|
|
|
19742
19826
|
```ruby
|
|
19743
19827
|
client.query.list_transactions(
|
|
19744
|
-
entry:
|
|
19828
|
+
entry: "8cfec329267",
|
|
19745
19829
|
from_record: 251,
|
|
19746
19830
|
limit_record: 0,
|
|
19747
|
-
sort_by:
|
|
19748
|
-
)
|
|
19831
|
+
sort_by: "desc(field_name)"
|
|
19832
|
+
)
|
|
19749
19833
|
```
|
|
19750
19834
|
</dd>
|
|
19751
19835
|
</dl>
|
|
@@ -19950,8 +20034,8 @@ client.query.list_transactions_org(
|
|
|
19950
20034
|
org_id: 123,
|
|
19951
20035
|
from_record: 251,
|
|
19952
20036
|
limit_record: 0,
|
|
19953
|
-
sort_by:
|
|
19954
|
-
)
|
|
20037
|
+
sort_by: "desc(field_name)"
|
|
20038
|
+
)
|
|
19955
20039
|
```
|
|
19956
20040
|
</dd>
|
|
19957
20041
|
</dl>
|
|
@@ -20138,9 +20222,9 @@ Retrieve a list of transfer details records for a paypoint. Use filters to limit
|
|
|
20138
20222
|
|
|
20139
20223
|
```ruby
|
|
20140
20224
|
client.query.list_transfer_details(
|
|
20141
|
-
entry:
|
|
20225
|
+
entry: "47862acd",
|
|
20142
20226
|
transfer_id: 123456
|
|
20143
|
-
)
|
|
20227
|
+
)
|
|
20144
20228
|
```
|
|
20145
20229
|
</dd>
|
|
20146
20230
|
</dl>
|
|
@@ -20290,10 +20374,10 @@ Retrieve a list of transfers for a paypoint. Use filters to limit results. Inclu
|
|
|
20290
20374
|
|
|
20291
20375
|
```ruby
|
|
20292
20376
|
client.query.list_transfers(
|
|
20293
|
-
entry:
|
|
20377
|
+
entry: "47862acd",
|
|
20294
20378
|
from_record: 0,
|
|
20295
20379
|
limit_record: 20
|
|
20296
|
-
)
|
|
20380
|
+
)
|
|
20297
20381
|
```
|
|
20298
20382
|
</dd>
|
|
20299
20383
|
</dl>
|
|
@@ -20435,7 +20519,7 @@ client.query.list_transfers_org(
|
|
|
20435
20519
|
org_id: 123,
|
|
20436
20520
|
from_record: 0,
|
|
20437
20521
|
limit_record: 20
|
|
20438
|
-
)
|
|
20522
|
+
)
|
|
20439
20523
|
```
|
|
20440
20524
|
</dd>
|
|
20441
20525
|
</dl>
|
|
@@ -20574,7 +20658,7 @@ client.query.list_transfers_out_org(
|
|
|
20574
20658
|
org_id: 77,
|
|
20575
20659
|
from_record: 0,
|
|
20576
20660
|
limit_record: 20
|
|
20577
|
-
)
|
|
20661
|
+
)
|
|
20578
20662
|
```
|
|
20579
20663
|
</dd>
|
|
20580
20664
|
</dl>
|
|
@@ -20698,10 +20782,10 @@ Retrieve a list of outbound transfers for a paypoint. Use filters to limit resul
|
|
|
20698
20782
|
|
|
20699
20783
|
```ruby
|
|
20700
20784
|
client.query.list_transfers_out_paypoint(
|
|
20701
|
-
entry:
|
|
20785
|
+
entry: "47cade237",
|
|
20702
20786
|
from_record: 0,
|
|
20703
20787
|
limit_record: 20
|
|
20704
|
-
)
|
|
20788
|
+
)
|
|
20705
20789
|
```
|
|
20706
20790
|
</dd>
|
|
20707
20791
|
</dl>
|
|
@@ -20825,11 +20909,11 @@ Retrieve details for a specific outbound transfer. Use filters to limit results.
|
|
|
20825
20909
|
|
|
20826
20910
|
```ruby
|
|
20827
20911
|
client.query.list_transfer_details_out(
|
|
20828
|
-
entry:
|
|
20912
|
+
entry: "47ace2b25",
|
|
20829
20913
|
transfer_id: 4521,
|
|
20830
20914
|
from_record: 0,
|
|
20831
20915
|
limit_record: 20
|
|
20832
|
-
)
|
|
20916
|
+
)
|
|
20833
20917
|
```
|
|
20834
20918
|
</dd>
|
|
20835
20919
|
</dl>
|
|
@@ -20963,8 +21047,8 @@ client.query.list_users_org(
|
|
|
20963
21047
|
org_id: 123,
|
|
20964
21048
|
from_record: 251,
|
|
20965
21049
|
limit_record: 0,
|
|
20966
|
-
sort_by:
|
|
20967
|
-
)
|
|
21050
|
+
sort_by: "desc(field_name)"
|
|
21051
|
+
)
|
|
20968
21052
|
```
|
|
20969
21053
|
</dd>
|
|
20970
21054
|
</dl>
|
|
@@ -21102,11 +21186,11 @@ Get list of users for a paypoint. Use filters to limit results.
|
|
|
21102
21186
|
|
|
21103
21187
|
```ruby
|
|
21104
21188
|
client.query.list_users_paypoint(
|
|
21105
|
-
entry:
|
|
21189
|
+
entry: "8cfec329267",
|
|
21106
21190
|
from_record: 251,
|
|
21107
21191
|
limit_record: 0,
|
|
21108
|
-
sort_by:
|
|
21109
|
-
)
|
|
21192
|
+
sort_by: "desc(field_name)"
|
|
21193
|
+
)
|
|
21110
21194
|
```
|
|
21111
21195
|
</dd>
|
|
21112
21196
|
</dl>
|
|
@@ -21244,11 +21328,11 @@ Retrieve a list of vendors for an entrypoint. Use filters to limit results. Incl
|
|
|
21244
21328
|
|
|
21245
21329
|
```ruby
|
|
21246
21330
|
client.query.list_vendors(
|
|
21247
|
-
entry:
|
|
21331
|
+
entry: "8cfec329267",
|
|
21248
21332
|
from_record: 251,
|
|
21249
21333
|
limit_record: 0,
|
|
21250
|
-
sort_by:
|
|
21251
|
-
)
|
|
21334
|
+
sort_by: "desc(field_name)"
|
|
21335
|
+
)
|
|
21252
21336
|
```
|
|
21253
21337
|
</dd>
|
|
21254
21338
|
</dl>
|
|
@@ -21409,8 +21493,8 @@ client.query.list_vendors_org(
|
|
|
21409
21493
|
org_id: 123,
|
|
21410
21494
|
from_record: 251,
|
|
21411
21495
|
limit_record: 0,
|
|
21412
|
-
sort_by:
|
|
21413
|
-
)
|
|
21496
|
+
sort_by: "desc(field_name)"
|
|
21497
|
+
)
|
|
21414
21498
|
```
|
|
21415
21499
|
</dd>
|
|
21416
21500
|
</dl>
|
|
@@ -21568,11 +21652,11 @@ Retrieve a list of vcards (virtual credit cards) issued for an entrypoint. Use f
|
|
|
21568
21652
|
|
|
21569
21653
|
```ruby
|
|
21570
21654
|
client.query.list_vcards(
|
|
21571
|
-
entry:
|
|
21655
|
+
entry: "8cfec329267",
|
|
21572
21656
|
from_record: 251,
|
|
21573
21657
|
limit_record: 0,
|
|
21574
|
-
sort_by:
|
|
21575
|
-
)
|
|
21658
|
+
sort_by: "desc(field_name)"
|
|
21659
|
+
)
|
|
21576
21660
|
```
|
|
21577
21661
|
</dd>
|
|
21578
21662
|
</dl>
|
|
@@ -21725,8 +21809,8 @@ client.query.list_vcards_org(
|
|
|
21725
21809
|
org_id: 123,
|
|
21726
21810
|
from_record: 251,
|
|
21727
21811
|
limit_record: 0,
|
|
21728
|
-
sort_by:
|
|
21729
|
-
)
|
|
21812
|
+
sort_by: "desc(field_name)"
|
|
21813
|
+
)
|
|
21730
21814
|
```
|
|
21731
21815
|
</dd>
|
|
21732
21816
|
</dl>
|
|
@@ -21878,12 +21962,12 @@ Retrieves the basic statistics for an organization or a paypoint, for a given ti
|
|
|
21878
21962
|
```ruby
|
|
21879
21963
|
client.statistic.basic_stats(
|
|
21880
21964
|
entry_id: 1000000,
|
|
21881
|
-
freq:
|
|
21965
|
+
freq: "m",
|
|
21882
21966
|
level: 1,
|
|
21883
|
-
mode:
|
|
21884
|
-
end_date:
|
|
21885
|
-
start_date:
|
|
21886
|
-
)
|
|
21967
|
+
mode: "ytd",
|
|
21968
|
+
end_date: "2025-11-01",
|
|
21969
|
+
start_date: "2025-11-30"
|
|
21970
|
+
)
|
|
21887
21971
|
```
|
|
21888
21972
|
</dd>
|
|
21889
21973
|
</dl>
|
|
@@ -22038,9 +22122,9 @@ Retrieves the basic statistics for a customer for a specific time period, groupe
|
|
|
22038
22122
|
```ruby
|
|
22039
22123
|
client.statistic.customer_basic_stats(
|
|
22040
22124
|
customer_id: 998,
|
|
22041
|
-
freq:
|
|
22042
|
-
mode:
|
|
22043
|
-
)
|
|
22125
|
+
freq: "m",
|
|
22126
|
+
mode: "ytd"
|
|
22127
|
+
)
|
|
22044
22128
|
```
|
|
22045
22129
|
</dd>
|
|
22046
22130
|
</dl>
|
|
@@ -22151,9 +22235,9 @@ Retrieves the subscription statistics for a given interval for a paypoint or org
|
|
|
22151
22235
|
```ruby
|
|
22152
22236
|
client.statistic.sub_stats(
|
|
22153
22237
|
entry_id: 1000000,
|
|
22154
|
-
interval:
|
|
22238
|
+
interval: "30",
|
|
22155
22239
|
level: 1
|
|
22156
|
-
)
|
|
22240
|
+
)
|
|
22157
22241
|
```
|
|
22158
22242
|
</dd>
|
|
22159
22243
|
</dl>
|
|
@@ -22252,10 +22336,10 @@ Retrieve the basic statistics about a vendor for a given time period, grouped by
|
|
|
22252
22336
|
|
|
22253
22337
|
```ruby
|
|
22254
22338
|
client.statistic.vendor_basic_stats(
|
|
22255
|
-
freq:
|
|
22339
|
+
freq: "m",
|
|
22256
22340
|
id_vendor: 1,
|
|
22257
|
-
mode:
|
|
22258
|
-
)
|
|
22341
|
+
mode: "ytd"
|
|
22342
|
+
)
|
|
22259
22343
|
```
|
|
22260
22344
|
</dd>
|
|
22261
22345
|
</dl>
|
|
@@ -22365,7 +22449,7 @@ Retrieves a single subscription's details.
|
|
|
22365
22449
|
<dd>
|
|
22366
22450
|
|
|
22367
22451
|
```ruby
|
|
22368
|
-
client.subscription.get_subscription(sub_id: 263)
|
|
22452
|
+
client.subscription.get_subscription(sub_id: 263)
|
|
22369
22453
|
```
|
|
22370
22454
|
</dd>
|
|
22371
22455
|
</dl>
|
|
@@ -22431,27 +22515,27 @@ client.subscription.new_subscription(
|
|
|
22431
22515
|
customer_data: {
|
|
22432
22516
|
customer_id: 4440
|
|
22433
22517
|
},
|
|
22434
|
-
entry_point:
|
|
22518
|
+
entry_point: "f743aed24a",
|
|
22435
22519
|
payment_details: {
|
|
22436
22520
|
service_fee: 0,
|
|
22437
22521
|
total_amount: 100
|
|
22438
22522
|
},
|
|
22439
22523
|
payment_method: {
|
|
22440
|
-
cardcvv:
|
|
22441
|
-
cardexp:
|
|
22442
|
-
card_holder:
|
|
22443
|
-
cardnumber:
|
|
22444
|
-
cardzip:
|
|
22445
|
-
initiator:
|
|
22446
|
-
method_:
|
|
22524
|
+
cardcvv: "123",
|
|
22525
|
+
cardexp: "02/25",
|
|
22526
|
+
card_holder: "John Cassian",
|
|
22527
|
+
cardnumber: "4111111111111111",
|
|
22528
|
+
cardzip: "37615",
|
|
22529
|
+
initiator: "payor",
|
|
22530
|
+
method_: "card"
|
|
22447
22531
|
},
|
|
22448
22532
|
schedule_details: {
|
|
22449
|
-
end_date:
|
|
22450
|
-
frequency:
|
|
22533
|
+
end_date: "03-20-2025",
|
|
22534
|
+
frequency: "weekly",
|
|
22451
22535
|
plan_id: 1,
|
|
22452
|
-
start_date:
|
|
22536
|
+
start_date: "09-20-2024"
|
|
22453
22537
|
}
|
|
22454
|
-
)
|
|
22538
|
+
)
|
|
22455
22539
|
```
|
|
22456
22540
|
</dd>
|
|
22457
22541
|
</dl>
|
|
@@ -22529,7 +22613,7 @@ Deletes a subscription, autopay, or recurring payment and prevents future charge
|
|
|
22529
22613
|
<dd>
|
|
22530
22614
|
|
|
22531
22615
|
```ruby
|
|
22532
|
-
client.subscription.remove_subscription(sub_id: 396)
|
|
22616
|
+
client.subscription.remove_subscription(sub_id: 396)
|
|
22533
22617
|
```
|
|
22534
22618
|
</dd>
|
|
22535
22619
|
</dl>
|
|
@@ -22594,7 +22678,7 @@ Updates a subscription's details.
|
|
|
22594
22678
|
client.subscription.update_subscription(
|
|
22595
22679
|
sub_id: 231,
|
|
22596
22680
|
set_pause: true
|
|
22597
|
-
)
|
|
22681
|
+
)
|
|
22598
22682
|
```
|
|
22599
22683
|
</dd>
|
|
22600
22684
|
</dl>
|
|
@@ -22681,7 +22765,7 @@ Deletes a template by ID.
|
|
|
22681
22765
|
<dd>
|
|
22682
22766
|
|
|
22683
22767
|
```ruby
|
|
22684
|
-
client.templates.delete_template(template_id: 80)
|
|
22768
|
+
client.templates.delete_template(template_id: 80)
|
|
22685
22769
|
```
|
|
22686
22770
|
</dd>
|
|
22687
22771
|
</dl>
|
|
@@ -22746,7 +22830,7 @@ Generates a boarding link from a boarding template.
|
|
|
22746
22830
|
client.templates.getlink_template(
|
|
22747
22831
|
ignore_empty: true,
|
|
22748
22832
|
template_id: 80
|
|
22749
|
-
)
|
|
22833
|
+
)
|
|
22750
22834
|
```
|
|
22751
22835
|
</dd>
|
|
22752
22836
|
</dl>
|
|
@@ -22816,7 +22900,7 @@ Retrieves a boarding template's details by ID.
|
|
|
22816
22900
|
<dd>
|
|
22817
22901
|
|
|
22818
22902
|
```ruby
|
|
22819
|
-
client.templates.get_template(template_id: 80)
|
|
22903
|
+
client.templates.get_template(template_id: 80)
|
|
22820
22904
|
```
|
|
22821
22905
|
</dd>
|
|
22822
22906
|
</dl>
|
|
@@ -22882,8 +22966,8 @@ client.templates.list_templates(
|
|
|
22882
22966
|
org_id: 123,
|
|
22883
22967
|
from_record: 251,
|
|
22884
22968
|
limit_record: 0,
|
|
22885
|
-
sort_by:
|
|
22886
|
-
)
|
|
22969
|
+
sort_by: "desc(field_name)"
|
|
22970
|
+
)
|
|
22887
22971
|
```
|
|
22888
22972
|
</dd>
|
|
22889
22973
|
</dl>
|
|
@@ -23027,17 +23111,17 @@ client.token_storage.add_method(
|
|
|
23027
23111
|
customer_data: {
|
|
23028
23112
|
customer_id: 4440
|
|
23029
23113
|
},
|
|
23030
|
-
entry_point:
|
|
23114
|
+
entry_point: "f743aed24a",
|
|
23031
23115
|
fallback_auth: true,
|
|
23032
23116
|
payment_method: {
|
|
23033
|
-
cardcvv:
|
|
23034
|
-
cardexp:
|
|
23035
|
-
card_holder:
|
|
23036
|
-
cardnumber:
|
|
23037
|
-
cardzip:
|
|
23038
|
-
method_:
|
|
23117
|
+
cardcvv: "123",
|
|
23118
|
+
cardexp: "02/25",
|
|
23119
|
+
card_holder: "John Doe",
|
|
23120
|
+
cardnumber: "4111111111111111",
|
|
23121
|
+
cardzip: "12345",
|
|
23122
|
+
method_: "card"
|
|
23039
23123
|
}
|
|
23040
|
-
)
|
|
23124
|
+
)
|
|
23041
23125
|
```
|
|
23042
23126
|
</dd>
|
|
23043
23127
|
</dl>
|
|
@@ -23140,10 +23224,10 @@ Retrieves details for a saved payment method.
|
|
|
23140
23224
|
|
|
23141
23225
|
```ruby
|
|
23142
23226
|
client.token_storage.get_method(
|
|
23143
|
-
method_id:
|
|
23227
|
+
method_id: "32-8877drt00045632-678",
|
|
23144
23228
|
card_expiration_format: 1,
|
|
23145
23229
|
include_temporary: false
|
|
23146
|
-
)
|
|
23230
|
+
)
|
|
23147
23231
|
```
|
|
23148
23232
|
</dd>
|
|
23149
23233
|
</dl>
|
|
@@ -23231,7 +23315,7 @@ Deletes a saved payment method.
|
|
|
23231
23315
|
<dd>
|
|
23232
23316
|
|
|
23233
23317
|
```ruby
|
|
23234
|
-
client.token_storage.remove_method(method_id:
|
|
23318
|
+
client.token_storage.remove_method(method_id: "32-8877drt00045632-678")
|
|
23235
23319
|
```
|
|
23236
23320
|
</dd>
|
|
23237
23321
|
</dl>
|
|
@@ -23294,21 +23378,21 @@ Updates a saved payment method.
|
|
|
23294
23378
|
|
|
23295
23379
|
```ruby
|
|
23296
23380
|
client.token_storage.update_method(
|
|
23297
|
-
method_id:
|
|
23381
|
+
method_id: "32-8877drt00045632-678",
|
|
23298
23382
|
customer_data: {
|
|
23299
23383
|
customer_id: 4440
|
|
23300
23384
|
},
|
|
23301
|
-
entry_point:
|
|
23385
|
+
entry_point: "f743aed24a",
|
|
23302
23386
|
fallback_auth: true,
|
|
23303
23387
|
payment_method: {
|
|
23304
|
-
cardcvv:
|
|
23305
|
-
cardexp:
|
|
23306
|
-
card_holder:
|
|
23307
|
-
cardnumber:
|
|
23308
|
-
cardzip:
|
|
23309
|
-
method_:
|
|
23388
|
+
cardcvv: "123",
|
|
23389
|
+
cardexp: "02/25",
|
|
23390
|
+
card_holder: "John Doe",
|
|
23391
|
+
cardnumber: "4111111111111111",
|
|
23392
|
+
cardzip: "12345",
|
|
23393
|
+
method_: "card"
|
|
23310
23394
|
}
|
|
23311
|
-
)
|
|
23395
|
+
)
|
|
23312
23396
|
```
|
|
23313
23397
|
</dd>
|
|
23314
23398
|
</dl>
|
|
@@ -23387,7 +23471,7 @@ Use this endpoint to add a new user to an organization.
|
|
|
23387
23471
|
<dd>
|
|
23388
23472
|
|
|
23389
23473
|
```ruby
|
|
23390
|
-
client.user.add_user
|
|
23474
|
+
client.user.add_user
|
|
23391
23475
|
```
|
|
23392
23476
|
</dd>
|
|
23393
23477
|
</dl>
|
|
@@ -23449,7 +23533,7 @@ Use this endpoint to refresh the authentication token for a user within an organ
|
|
|
23449
23533
|
<dd>
|
|
23450
23534
|
|
|
23451
23535
|
```ruby
|
|
23452
|
-
client.user.auth_refresh_user
|
|
23536
|
+
client.user.auth_refresh_user
|
|
23453
23537
|
```
|
|
23454
23538
|
</dd>
|
|
23455
23539
|
</dl>
|
|
@@ -23503,7 +23587,7 @@ Use this endpoint to initiate a password reset for a user within an organization
|
|
|
23503
23587
|
<dd>
|
|
23504
23588
|
|
|
23505
23589
|
```ruby
|
|
23506
|
-
client.user.auth_reset_user
|
|
23590
|
+
client.user.auth_reset_user
|
|
23507
23591
|
```
|
|
23508
23592
|
</dd>
|
|
23509
23593
|
</dl>
|
|
@@ -23581,7 +23665,7 @@ This endpoint requires an application API token.
|
|
|
23581
23665
|
<dd>
|
|
23582
23666
|
|
|
23583
23667
|
```ruby
|
|
23584
|
-
client.user.auth_user(provider:
|
|
23668
|
+
client.user.auth_user(provider: "provider")
|
|
23585
23669
|
```
|
|
23586
23670
|
</dd>
|
|
23587
23671
|
</dl>
|
|
@@ -23691,7 +23775,7 @@ Use this endpoint to change the password for a user within an organization.
|
|
|
23691
23775
|
<dd>
|
|
23692
23776
|
|
|
23693
23777
|
```ruby
|
|
23694
|
-
client.user.change_psw_user
|
|
23778
|
+
client.user.change_psw_user
|
|
23695
23779
|
```
|
|
23696
23780
|
</dd>
|
|
23697
23781
|
</dl>
|
|
@@ -23753,7 +23837,7 @@ Use this endpoint to delete a specific user within an organization.
|
|
|
23753
23837
|
<dd>
|
|
23754
23838
|
|
|
23755
23839
|
```ruby
|
|
23756
|
-
client.user.delete_user(user_id: 1000000)
|
|
23840
|
+
client.user.delete_user(user_id: 1000000)
|
|
23757
23841
|
```
|
|
23758
23842
|
</dd>
|
|
23759
23843
|
</dl>
|
|
@@ -23815,7 +23899,7 @@ Use this endpoint to enable or disable multi-factor authentication (MFA) for a u
|
|
|
23815
23899
|
<dd>
|
|
23816
23900
|
|
|
23817
23901
|
```ruby
|
|
23818
|
-
client.user.edit_mfa_user(user_id: 1000000)
|
|
23902
|
+
client.user.edit_mfa_user(user_id: 1000000)
|
|
23819
23903
|
```
|
|
23820
23904
|
</dd>
|
|
23821
23905
|
</dl>
|
|
@@ -23885,7 +23969,7 @@ Use this endpoint to modify the details of a specific user within an organizatio
|
|
|
23885
23969
|
<dd>
|
|
23886
23970
|
|
|
23887
23971
|
```ruby
|
|
23888
|
-
client.user.edit_user(user_id: 1000000)
|
|
23972
|
+
client.user.edit_user(user_id: 1000000)
|
|
23889
23973
|
```
|
|
23890
23974
|
</dd>
|
|
23891
23975
|
</dl>
|
|
@@ -23957,8 +24041,8 @@ Use this endpoint to retrieve information about a specific user within an organi
|
|
|
23957
24041
|
```ruby
|
|
23958
24042
|
client.user.get_user(
|
|
23959
24043
|
user_id: 1000000,
|
|
23960
|
-
entry:
|
|
23961
|
-
)
|
|
24044
|
+
entry: "478ae1234"
|
|
24045
|
+
)
|
|
23962
24046
|
```
|
|
23963
24047
|
</dd>
|
|
23964
24048
|
</dl>
|
|
@@ -24036,7 +24120,7 @@ Use this endpoint to log a user out from the system.
|
|
|
24036
24120
|
<dd>
|
|
24037
24121
|
|
|
24038
24122
|
```ruby
|
|
24039
|
-
client.user.logout_user
|
|
24123
|
+
client.user.logout_user
|
|
24040
24124
|
```
|
|
24041
24125
|
</dd>
|
|
24042
24126
|
</dl>
|
|
@@ -24091,10 +24175,10 @@ Resends the MFA code to the user via the selected MFA mode (email or SMS).
|
|
|
24091
24175
|
|
|
24092
24176
|
```ruby
|
|
24093
24177
|
client.user.resend_mfa_code(
|
|
24094
|
-
entry:
|
|
24178
|
+
entry: "Entry",
|
|
24095
24179
|
entry_type: 1,
|
|
24096
|
-
usrname:
|
|
24097
|
-
)
|
|
24180
|
+
usrname: "usrname"
|
|
24181
|
+
)
|
|
24098
24182
|
```
|
|
24099
24183
|
</dd>
|
|
24100
24184
|
</dl>
|
|
@@ -24172,7 +24256,7 @@ Use this endpoint to validate the multi-factor authentication (MFA) code for a u
|
|
|
24172
24256
|
<dd>
|
|
24173
24257
|
|
|
24174
24258
|
```ruby
|
|
24175
|
-
client.user.validate_mfa_user
|
|
24259
|
+
client.user.validate_mfa_user
|
|
24176
24260
|
```
|
|
24177
24261
|
</dd>
|
|
24178
24262
|
</dl>
|
|
@@ -24244,50 +24328,50 @@ Creates a vendor in an entrypoint.
|
|
|
24244
24328
|
|
|
24245
24329
|
```ruby
|
|
24246
24330
|
client.vendor.add_vendor(
|
|
24247
|
-
entry:
|
|
24248
|
-
vendor_number:
|
|
24249
|
-
address_1:
|
|
24250
|
-
address_2:
|
|
24331
|
+
entry: "8cfec329267",
|
|
24332
|
+
vendor_number: "1234",
|
|
24333
|
+
address_1: "123 Ocean Drive",
|
|
24334
|
+
address_2: "Suite 400",
|
|
24251
24335
|
billing_data: {
|
|
24252
24336
|
id: 123,
|
|
24253
|
-
bank_name:
|
|
24254
|
-
routing_account:
|
|
24255
|
-
account_number:
|
|
24256
|
-
type_account:
|
|
24257
|
-
bank_account_holder_name:
|
|
24258
|
-
bank_account_holder_type:
|
|
24337
|
+
bank_name: "Country Bank",
|
|
24338
|
+
routing_account: "123123123",
|
|
24339
|
+
account_number: "123123123",
|
|
24340
|
+
type_account: "Checking",
|
|
24341
|
+
bank_account_holder_name: "Gruzya Adventure Outfitters LLC",
|
|
24342
|
+
bank_account_holder_type: "Business",
|
|
24259
24343
|
bank_account_function: 0
|
|
24260
24344
|
},
|
|
24261
|
-
city:
|
|
24345
|
+
city: "Miami",
|
|
24262
24346
|
contacts: [{
|
|
24263
|
-
contact_name:
|
|
24264
|
-
contact_email:
|
|
24265
|
-
contact_title:
|
|
24266
|
-
contact_phone:
|
|
24347
|
+
contact_name: "Herman Martinez",
|
|
24348
|
+
contact_email: "example@email.com",
|
|
24349
|
+
contact_title: "Owner",
|
|
24350
|
+
contact_phone: "3055550000"
|
|
24267
24351
|
}],
|
|
24268
|
-
country:
|
|
24269
|
-
customer_vendor_account:
|
|
24270
|
-
ein:
|
|
24271
|
-
email:
|
|
24352
|
+
country: "US",
|
|
24353
|
+
customer_vendor_account: "A-37622",
|
|
24354
|
+
ein: "12-3456789",
|
|
24355
|
+
email: "example@email.com",
|
|
24272
24356
|
internal_reference_id: 123,
|
|
24273
|
-
location_code:
|
|
24274
|
-
mcc:
|
|
24357
|
+
location_code: "MIA123",
|
|
24358
|
+
mcc: "7777",
|
|
24275
24359
|
name_1: "Herman's Coatings and Masonry",
|
|
24276
|
-
name_2:
|
|
24277
|
-
payee_name_1:
|
|
24278
|
-
payee_name_2:
|
|
24279
|
-
payment_method:
|
|
24280
|
-
phone:
|
|
24281
|
-
remit_address_1:
|
|
24282
|
-
remit_address_2:
|
|
24283
|
-
remit_city:
|
|
24284
|
-
remit_country:
|
|
24285
|
-
remit_state:
|
|
24286
|
-
remit_zip:
|
|
24287
|
-
state:
|
|
24360
|
+
name_2: "<string>",
|
|
24361
|
+
payee_name_1: "<string>",
|
|
24362
|
+
payee_name_2: "<string>",
|
|
24363
|
+
payment_method: "managed",
|
|
24364
|
+
phone: "5555555555",
|
|
24365
|
+
remit_address_1: "123 Walnut Street",
|
|
24366
|
+
remit_address_2: "Suite 900",
|
|
24367
|
+
remit_city: "Miami",
|
|
24368
|
+
remit_country: "US",
|
|
24369
|
+
remit_state: "FL",
|
|
24370
|
+
remit_zip: "31113",
|
|
24371
|
+
state: "FL",
|
|
24288
24372
|
vendor_status: 1,
|
|
24289
|
-
zip:
|
|
24290
|
-
)
|
|
24373
|
+
zip: "33139"
|
|
24374
|
+
)
|
|
24291
24375
|
```
|
|
24292
24376
|
</dd>
|
|
24293
24377
|
</dl>
|
|
@@ -24357,7 +24441,7 @@ Delete a vendor.
|
|
|
24357
24441
|
<dd>
|
|
24358
24442
|
|
|
24359
24443
|
```ruby
|
|
24360
|
-
client.vendor.delete_vendor(id_vendor: 1)
|
|
24444
|
+
client.vendor.delete_vendor(id_vendor: 1)
|
|
24361
24445
|
```
|
|
24362
24446
|
</dd>
|
|
24363
24447
|
</dl>
|
|
@@ -24422,7 +24506,7 @@ Updates a vendor's information. Send only the fields you need to update.
|
|
|
24422
24506
|
client.vendor.edit_vendor(
|
|
24423
24507
|
id_vendor: 1,
|
|
24424
24508
|
name_1: "Theodore's Janitorial"
|
|
24425
|
-
)
|
|
24509
|
+
)
|
|
24426
24510
|
```
|
|
24427
24511
|
</dd>
|
|
24428
24512
|
</dl>
|
|
@@ -24492,7 +24576,7 @@ Retrieves a vendor's details.
|
|
|
24492
24576
|
<dd>
|
|
24493
24577
|
|
|
24494
24578
|
```ruby
|
|
24495
|
-
client.vendor.get_vendor(id_vendor: 1)
|
|
24579
|
+
client.vendor.get_vendor(id_vendor: 1)
|
|
24496
24580
|
```
|
|
24497
24581
|
</dd>
|
|
24498
24582
|
</dl>
|
|
@@ -24559,7 +24643,7 @@ client.wallet.configure_apple_pay_organization(
|
|
|
24559
24643
|
cascade: true,
|
|
24560
24644
|
is_enabled: true,
|
|
24561
24645
|
org_id: 901
|
|
24562
|
-
)
|
|
24646
|
+
)
|
|
24563
24647
|
```
|
|
24564
24648
|
</dd>
|
|
24565
24649
|
</dl>
|
|
@@ -24638,9 +24722,9 @@ Configure and activate Apple Pay for a Payabli paypoint
|
|
|
24638
24722
|
|
|
24639
24723
|
```ruby
|
|
24640
24724
|
client.wallet.configure_apple_pay_paypoint(
|
|
24641
|
-
entry:
|
|
24725
|
+
entry: "8cfec329267",
|
|
24642
24726
|
is_enabled: true
|
|
24643
|
-
)
|
|
24727
|
+
)
|
|
24644
24728
|
```
|
|
24645
24729
|
</dd>
|
|
24646
24730
|
</dl>
|
|
@@ -24714,7 +24798,7 @@ client.wallet.configure_google_pay_organization(
|
|
|
24714
24798
|
cascade: true,
|
|
24715
24799
|
is_enabled: true,
|
|
24716
24800
|
org_id: 901
|
|
24717
|
-
)
|
|
24801
|
+
)
|
|
24718
24802
|
```
|
|
24719
24803
|
</dd>
|
|
24720
24804
|
</dl>
|
|
@@ -24793,9 +24877,9 @@ Configure and activate Google Pay for a Payabli paypoint
|
|
|
24793
24877
|
|
|
24794
24878
|
```ruby
|
|
24795
24879
|
client.wallet.configure_google_pay_paypoint(
|
|
24796
|
-
entry:
|
|
24880
|
+
entry: "8cfec329267",
|
|
24797
24881
|
is_enabled: true
|
|
24798
|
-
)
|
|
24882
|
+
)
|
|
24799
24883
|
```
|
|
24800
24884
|
</dd>
|
|
24801
24885
|
</dl>
|