payabli 2.2.15 → 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/types/payment_detail.rb +1 -0
- data/lib/payabli/version.rb +1 -1
- data/reference.md +813 -813
- metadata +1 -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>
|
|
@@ -12404,9 +12404,9 @@ The transaction must meet all of the following criteria:
|
|
|
12404
12404
|
|
|
12405
12405
|
```ruby
|
|
12406
12406
|
client.money_out.update_check_payment_status(
|
|
12407
|
-
trans_id:
|
|
12408
|
-
check_payment_status:
|
|
12409
|
-
)
|
|
12407
|
+
trans_id: "TRANS123456",
|
|
12408
|
+
check_payment_status: "5"
|
|
12409
|
+
)
|
|
12410
12410
|
```
|
|
12411
12411
|
</dd>
|
|
12412
12412
|
</dl>
|
|
@@ -12479,15 +12479,15 @@ Create a new notification or autogenerated report.
|
|
|
12479
12479
|
```ruby
|
|
12480
12480
|
client.notification.add_notification(
|
|
12481
12481
|
content: {
|
|
12482
|
-
event_type:
|
|
12482
|
+
event_type: "CreatedApplication"
|
|
12483
12483
|
},
|
|
12484
|
-
frequency:
|
|
12485
|
-
method_:
|
|
12486
|
-
owner_id:
|
|
12484
|
+
frequency: "untilcancelled",
|
|
12485
|
+
method_: "web",
|
|
12486
|
+
owner_id: "236",
|
|
12487
12487
|
owner_type: 0,
|
|
12488
12488
|
status: 1,
|
|
12489
|
-
target:
|
|
12490
|
-
)
|
|
12489
|
+
target: "https://webhook.site/2871b8f8-edc7-441a-b376-98d8c8e33275"
|
|
12490
|
+
)
|
|
12491
12491
|
```
|
|
12492
12492
|
</dd>
|
|
12493
12493
|
</dl>
|
|
@@ -12549,7 +12549,7 @@ Deletes a single notification or autogenerated report.
|
|
|
12549
12549
|
<dd>
|
|
12550
12550
|
|
|
12551
12551
|
```ruby
|
|
12552
|
-
client.notification.delete_notification(n_id:
|
|
12552
|
+
client.notification.delete_notification(n_id: "1717")
|
|
12553
12553
|
```
|
|
12554
12554
|
</dd>
|
|
12555
12555
|
</dl>
|
|
@@ -12611,7 +12611,7 @@ Retrieves a single notification or autogenerated report's details.
|
|
|
12611
12611
|
<dd>
|
|
12612
12612
|
|
|
12613
12613
|
```ruby
|
|
12614
|
-
client.notification.get_notification(n_id:
|
|
12614
|
+
client.notification.get_notification(n_id: "1717")
|
|
12615
12615
|
```
|
|
12616
12616
|
</dd>
|
|
12617
12617
|
</dl>
|
|
@@ -12674,17 +12674,17 @@ Update a notification or autogenerated report.
|
|
|
12674
12674
|
|
|
12675
12675
|
```ruby
|
|
12676
12676
|
client.notification.update_notification(
|
|
12677
|
-
n_id:
|
|
12677
|
+
n_id: "1717",
|
|
12678
12678
|
content: {
|
|
12679
|
-
event_type:
|
|
12679
|
+
event_type: "ApprovedPayment"
|
|
12680
12680
|
},
|
|
12681
|
-
frequency:
|
|
12682
|
-
method_:
|
|
12683
|
-
owner_id:
|
|
12681
|
+
frequency: "untilcancelled",
|
|
12682
|
+
method_: "email",
|
|
12683
|
+
owner_id: "136",
|
|
12684
12684
|
owner_type: 0,
|
|
12685
12685
|
status: 1,
|
|
12686
|
-
target:
|
|
12687
|
-
)
|
|
12686
|
+
target: "newemail@email.com"
|
|
12687
|
+
)
|
|
12688
12688
|
```
|
|
12689
12689
|
</dd>
|
|
12690
12690
|
</dl>
|
|
@@ -12754,7 +12754,7 @@ Gets a copy of a generated report by ID.
|
|
|
12754
12754
|
<dd>
|
|
12755
12755
|
|
|
12756
12756
|
```ruby
|
|
12757
|
-
client.notification.get_report_file(id: 1000000)
|
|
12757
|
+
client.notification.get_report_file(id: 1000000)
|
|
12758
12758
|
```
|
|
12759
12759
|
</dd>
|
|
12760
12760
|
</dl>
|
|
@@ -12823,12 +12823,12 @@ This endpoint requires the `notifications_create` OR `notifications_read` permis
|
|
|
12823
12823
|
```ruby
|
|
12824
12824
|
client.notificationlogs.search_notification_logs(
|
|
12825
12825
|
page_size: 20,
|
|
12826
|
-
start_date:
|
|
12827
|
-
end_date:
|
|
12828
|
-
notification_event:
|
|
12826
|
+
start_date: "2024-01-01T00:00:00Z",
|
|
12827
|
+
end_date: "2024-01-31T23:59:59Z",
|
|
12828
|
+
notification_event: "ActivatedMerchant",
|
|
12829
12829
|
succeeded: true,
|
|
12830
12830
|
org_id: 12345
|
|
12831
|
-
)
|
|
12831
|
+
)
|
|
12832
12832
|
```
|
|
12833
12833
|
</dd>
|
|
12834
12834
|
</dl>
|
|
@@ -12907,7 +12907,7 @@ This endpoint requires the `notifications_create` OR `notifications_read` permis
|
|
|
12907
12907
|
<dd>
|
|
12908
12908
|
|
|
12909
12909
|
```ruby
|
|
12910
|
-
client.notificationlogs.get_notification_log(uuid:
|
|
12910
|
+
client.notificationlogs.get_notification_log(uuid: "550e8400-e29b-41d4-a716-446655440000")
|
|
12911
12911
|
```
|
|
12912
12912
|
</dd>
|
|
12913
12913
|
</dl>
|
|
@@ -12971,7 +12971,7 @@ Retry sending a specific notification.
|
|
|
12971
12971
|
<dd>
|
|
12972
12972
|
|
|
12973
12973
|
```ruby
|
|
12974
|
-
client.notificationlogs.retry_notification_log(uuid:
|
|
12974
|
+
client.notificationlogs.retry_notification_log(uuid: "550e8400-e29b-41d4-a716-446655440000")
|
|
12975
12975
|
```
|
|
12976
12976
|
</dd>
|
|
12977
12977
|
</dl>
|
|
@@ -13036,7 +13036,7 @@ This endpoint requires the `notifications_create` permission.
|
|
|
13036
13036
|
<dd>
|
|
13037
13037
|
|
|
13038
13038
|
```ruby
|
|
13039
|
-
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])
|
|
13040
13040
|
```
|
|
13041
13041
|
</dd>
|
|
13042
13042
|
</dl>
|
|
@@ -13099,7 +13099,7 @@ Use this endpoint to upload an image file for OCR processing. The accepted file
|
|
|
13099
13099
|
<dd>
|
|
13100
13100
|
|
|
13101
13101
|
```ruby
|
|
13102
|
-
client.ocr.ocr_document_form(type_result:
|
|
13102
|
+
client.ocr.ocr_document_form(type_result: "typeResult")
|
|
13103
13103
|
```
|
|
13104
13104
|
</dd>
|
|
13105
13105
|
</dl>
|
|
@@ -13169,7 +13169,7 @@ Use this endpoint to submit a Base64-encoded image file for OCR processing. The
|
|
|
13169
13169
|
<dd>
|
|
13170
13170
|
|
|
13171
13171
|
```ruby
|
|
13172
|
-
client.ocr.ocr_document_json(type_result:
|
|
13172
|
+
client.ocr.ocr_document_json(type_result: "typeResult")
|
|
13173
13173
|
```
|
|
13174
13174
|
</dd>
|
|
13175
13175
|
</dl>
|
|
@@ -13241,44 +13241,44 @@ Creates an organization under a parent organization. This is also referred to as
|
|
|
13241
13241
|
|
|
13242
13242
|
```ruby
|
|
13243
13243
|
client.organization.add_organization(
|
|
13244
|
-
idempotency_key:
|
|
13244
|
+
idempotency_key: "6B29FC40-CA47-1067-B31D-00DD010662DA",
|
|
13245
13245
|
billing_info: {
|
|
13246
|
-
ach_account:
|
|
13247
|
-
ach_routing:
|
|
13248
|
-
billing_address:
|
|
13249
|
-
billing_city:
|
|
13250
|
-
billing_country:
|
|
13251
|
-
billing_state:
|
|
13252
|
-
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"
|
|
13253
13253
|
},
|
|
13254
13254
|
contacts: [{
|
|
13255
|
-
contact_email:
|
|
13256
|
-
contact_name:
|
|
13257
|
-
contact_phone:
|
|
13258
|
-
contact_title:
|
|
13255
|
+
contact_email: "herman@hermanscoatings.com",
|
|
13256
|
+
contact_name: "Herman Martinez",
|
|
13257
|
+
contact_phone: "3055550000",
|
|
13258
|
+
contact_title: "Owner"
|
|
13259
13259
|
}],
|
|
13260
13260
|
has_billing: true,
|
|
13261
13261
|
has_residual: true,
|
|
13262
|
-
org_address:
|
|
13263
|
-
org_city:
|
|
13264
|
-
org_country:
|
|
13265
|
-
org_entry_name:
|
|
13266
|
-
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",
|
|
13267
13267
|
org_logo: {
|
|
13268
|
-
f_content:
|
|
13269
|
-
filename:
|
|
13270
|
-
ftype:
|
|
13271
|
-
furl:
|
|
13268
|
+
f_content: "TXkgdGVzdCBmaWxlHJ==...",
|
|
13269
|
+
filename: "my-doc.pdf",
|
|
13270
|
+
ftype: "pdf",
|
|
13271
|
+
furl: "https://mysite.com/my-doc.pdf"
|
|
13272
13272
|
},
|
|
13273
|
-
org_name:
|
|
13273
|
+
org_name: "Pilgrim Planner",
|
|
13274
13274
|
org_parent_id: 236,
|
|
13275
|
-
org_state:
|
|
13275
|
+
org_state: "TN",
|
|
13276
13276
|
org_timezone: -5,
|
|
13277
13277
|
org_type: 0,
|
|
13278
|
-
org_website:
|
|
13279
|
-
org_zip:
|
|
13280
|
-
reply_to_email:
|
|
13281
|
-
)
|
|
13278
|
+
org_website: "www.pilgrimageplanner.com",
|
|
13279
|
+
org_zip: "37615",
|
|
13280
|
+
reply_to_email: "email@example.com"
|
|
13281
|
+
)
|
|
13282
13282
|
```
|
|
13283
13283
|
</dd>
|
|
13284
13284
|
</dl>
|
|
@@ -13492,7 +13492,7 @@ Delete an organization by ID.
|
|
|
13492
13492
|
<dd>
|
|
13493
13493
|
|
|
13494
13494
|
```ruby
|
|
13495
|
-
client.organization.delete_organization(org_id: 123)
|
|
13495
|
+
client.organization.delete_organization(org_id: 123)
|
|
13496
13496
|
```
|
|
13497
13497
|
</dd>
|
|
13498
13498
|
</dl>
|
|
@@ -13557,23 +13557,23 @@ Updates an organization's details by ID.
|
|
|
13557
13557
|
client.organization.edit_organization(
|
|
13558
13558
|
org_id: 123,
|
|
13559
13559
|
contacts: [{
|
|
13560
|
-
contact_email:
|
|
13561
|
-
contact_name:
|
|
13562
|
-
contact_phone:
|
|
13563
|
-
contact_title:
|
|
13560
|
+
contact_email: "herman@hermanscoatings.com",
|
|
13561
|
+
contact_name: "Herman Martinez",
|
|
13562
|
+
contact_phone: "3055550000",
|
|
13563
|
+
contact_title: "Owner"
|
|
13564
13564
|
}],
|
|
13565
|
-
org_address:
|
|
13566
|
-
org_city:
|
|
13567
|
-
org_country:
|
|
13568
|
-
org_entry_name:
|
|
13569
|
-
organization_data_org_id:
|
|
13570
|
-
org_name:
|
|
13571
|
-
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",
|
|
13572
13572
|
org_timezone: -5,
|
|
13573
13573
|
org_type: 0,
|
|
13574
|
-
org_website:
|
|
13575
|
-
org_zip:
|
|
13576
|
-
)
|
|
13574
|
+
org_website: "www.pilgrimageplanner.com",
|
|
13575
|
+
org_zip: "37615"
|
|
13576
|
+
)
|
|
13577
13577
|
```
|
|
13578
13578
|
</dd>
|
|
13579
13579
|
</dl>
|
|
@@ -13787,7 +13787,7 @@ Gets an organization's basic information by entry name (entrypoint identifier).
|
|
|
13787
13787
|
<dd>
|
|
13788
13788
|
|
|
13789
13789
|
```ruby
|
|
13790
|
-
client.organization.get_basic_organization(entry:
|
|
13790
|
+
client.organization.get_basic_organization(entry: "8cfec329267")
|
|
13791
13791
|
```
|
|
13792
13792
|
</dd>
|
|
13793
13793
|
</dl>
|
|
@@ -13849,7 +13849,7 @@ Gets an organizations basic details by org ID.
|
|
|
13849
13849
|
<dd>
|
|
13850
13850
|
|
|
13851
13851
|
```ruby
|
|
13852
|
-
client.organization.get_basic_organization_by_id(org_id: 123)
|
|
13852
|
+
client.organization.get_basic_organization_by_id(org_id: 123)
|
|
13853
13853
|
```
|
|
13854
13854
|
</dd>
|
|
13855
13855
|
</dl>
|
|
@@ -13911,7 +13911,7 @@ Retrieves details for an organization by ID.
|
|
|
13911
13911
|
<dd>
|
|
13912
13912
|
|
|
13913
13913
|
```ruby
|
|
13914
|
-
client.organization.get_organization(org_id: 123)
|
|
13914
|
+
client.organization.get_organization(org_id: 123)
|
|
13915
13915
|
```
|
|
13916
13916
|
</dd>
|
|
13917
13917
|
</dl>
|
|
@@ -13973,7 +13973,7 @@ Retrieves an organization's settings.
|
|
|
13973
13973
|
<dd>
|
|
13974
13974
|
|
|
13975
13975
|
```ruby
|
|
13976
|
-
client.organization.get_settings_organization(org_id: 123)
|
|
13976
|
+
client.organization.get_settings_organization(org_id: 123)
|
|
13977
13977
|
```
|
|
13978
13978
|
</dd>
|
|
13979
13979
|
</dl>
|
|
@@ -14038,26 +14038,26 @@ Generates a payment link for an invoice from the invoice ID.
|
|
|
14038
14038
|
```ruby
|
|
14039
14039
|
client.payment_link.add_pay_link_from_invoice(
|
|
14040
14040
|
id_invoice: 23548884,
|
|
14041
|
-
mail_2:
|
|
14041
|
+
mail_2: "jo@example.com; ceo@example.com",
|
|
14042
14042
|
contact_us: {
|
|
14043
|
-
email_label:
|
|
14043
|
+
email_label: "Email",
|
|
14044
14044
|
enabled: true,
|
|
14045
|
-
header:
|
|
14045
|
+
header: "Contact Us",
|
|
14046
14046
|
order: 0,
|
|
14047
14047
|
payment_icons: true,
|
|
14048
|
-
phone_label:
|
|
14048
|
+
phone_label: "Phone"
|
|
14049
14049
|
},
|
|
14050
14050
|
invoices: {
|
|
14051
14051
|
enabled: true,
|
|
14052
14052
|
invoice_link: {
|
|
14053
14053
|
enabled: true,
|
|
14054
|
-
label:
|
|
14054
|
+
label: "View Invoice",
|
|
14055
14055
|
order: 0
|
|
14056
14056
|
},
|
|
14057
14057
|
order: 0,
|
|
14058
14058
|
view_invoice_details: {
|
|
14059
14059
|
enabled: true,
|
|
14060
|
-
label:
|
|
14060
|
+
label: "Invoice Details",
|
|
14061
14061
|
order: 0
|
|
14062
14062
|
}
|
|
14063
14063
|
},
|
|
@@ -14067,31 +14067,31 @@ client.payment_link.add_pay_link_from_invoice(
|
|
|
14067
14067
|
},
|
|
14068
14068
|
message_before_paying: {
|
|
14069
14069
|
enabled: true,
|
|
14070
|
-
label:
|
|
14070
|
+
label: "Please review your payment details",
|
|
14071
14071
|
order: 0
|
|
14072
14072
|
},
|
|
14073
14073
|
notes: {
|
|
14074
14074
|
enabled: true,
|
|
14075
|
-
header:
|
|
14075
|
+
header: "Additional Notes",
|
|
14076
14076
|
order: 0,
|
|
14077
|
-
placeholder:
|
|
14078
|
-
value:
|
|
14077
|
+
placeholder: "Enter any additional notes here",
|
|
14078
|
+
value: ""
|
|
14079
14079
|
},
|
|
14080
14080
|
page: {
|
|
14081
|
-
description:
|
|
14081
|
+
description: "Complete your payment securely",
|
|
14082
14082
|
enabled: true,
|
|
14083
|
-
header:
|
|
14083
|
+
header: "Payment Page",
|
|
14084
14084
|
order: 0
|
|
14085
14085
|
},
|
|
14086
14086
|
payment_button: {
|
|
14087
14087
|
enabled: true,
|
|
14088
|
-
label:
|
|
14088
|
+
label: "Pay Now",
|
|
14089
14089
|
order: 0
|
|
14090
14090
|
},
|
|
14091
14091
|
payment_methods: {
|
|
14092
14092
|
all_methods_checked: true,
|
|
14093
14093
|
enabled: true,
|
|
14094
|
-
header:
|
|
14094
|
+
header: "Payment Methods",
|
|
14095
14095
|
methods: {
|
|
14096
14096
|
amex: true,
|
|
14097
14097
|
apple_pay: true,
|
|
@@ -14103,9 +14103,9 @@ client.payment_link.add_pay_link_from_invoice(
|
|
|
14103
14103
|
order: 0,
|
|
14104
14104
|
settings: {
|
|
14105
14105
|
apple_pay: {
|
|
14106
|
-
button_style:
|
|
14107
|
-
button_type:
|
|
14108
|
-
language:
|
|
14106
|
+
button_style: "black",
|
|
14107
|
+
button_type: "pay",
|
|
14108
|
+
language: "en-US"
|
|
14109
14109
|
}
|
|
14110
14110
|
}
|
|
14111
14111
|
},
|
|
@@ -14115,36 +14115,36 @@ client.payment_link.add_pay_link_from_invoice(
|
|
|
14115
14115
|
display: true,
|
|
14116
14116
|
fixed: true,
|
|
14117
14117
|
identifier: true,
|
|
14118
|
-
label:
|
|
14119
|
-
name:
|
|
14118
|
+
label: "Full Name",
|
|
14119
|
+
name: "fullName",
|
|
14120
14120
|
order: 0,
|
|
14121
14121
|
required: true,
|
|
14122
|
-
validation:
|
|
14123
|
-
value:
|
|
14122
|
+
validation: "alpha",
|
|
14123
|
+
value: "",
|
|
14124
14124
|
width: 0
|
|
14125
14125
|
}],
|
|
14126
|
-
header:
|
|
14126
|
+
header: "Payor Information",
|
|
14127
14127
|
order: 0
|
|
14128
14128
|
},
|
|
14129
14129
|
review: {
|
|
14130
14130
|
enabled: true,
|
|
14131
|
-
header:
|
|
14131
|
+
header: "Review Payment",
|
|
14132
14132
|
order: 0
|
|
14133
14133
|
},
|
|
14134
14134
|
settings: {
|
|
14135
14135
|
color: "#000000",
|
|
14136
|
-
custom_css_url:
|
|
14137
|
-
language:
|
|
14136
|
+
custom_css_url: "https://example.com/custom.css",
|
|
14137
|
+
language: "en",
|
|
14138
14138
|
page_logo: {
|
|
14139
|
-
f_content:
|
|
14140
|
-
filename:
|
|
14141
|
-
ftype:
|
|
14142
|
-
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: ""
|
|
14143
14143
|
},
|
|
14144
14144
|
redirect_after_approve: true,
|
|
14145
|
-
redirect_after_approve_url:
|
|
14145
|
+
redirect_after_approve_url: "https://example.com/success"
|
|
14146
14146
|
}
|
|
14147
|
-
)
|
|
14147
|
+
)
|
|
14148
14148
|
```
|
|
14149
14149
|
</dd>
|
|
14150
14150
|
</dl>
|
|
@@ -14240,14 +14240,14 @@ Generates a payment link for a bill from the bill ID.
|
|
|
14240
14240
|
```ruby
|
|
14241
14241
|
client.payment_link.add_pay_link_from_bill(
|
|
14242
14242
|
bill_id: 23548884,
|
|
14243
|
-
mail_2:
|
|
14243
|
+
mail_2: "jo@example.com; ceo@example.com",
|
|
14244
14244
|
contact_us: {
|
|
14245
|
-
email_label:
|
|
14245
|
+
email_label: "Email",
|
|
14246
14246
|
enabled: true,
|
|
14247
|
-
header:
|
|
14247
|
+
header: "Contact Us",
|
|
14248
14248
|
order: 0,
|
|
14249
14249
|
payment_icons: true,
|
|
14250
|
-
phone_label:
|
|
14250
|
+
phone_label: "Phone"
|
|
14251
14251
|
},
|
|
14252
14252
|
logo: {
|
|
14253
14253
|
enabled: true,
|
|
@@ -14255,31 +14255,31 @@ client.payment_link.add_pay_link_from_bill(
|
|
|
14255
14255
|
},
|
|
14256
14256
|
message_before_paying: {
|
|
14257
14257
|
enabled: true,
|
|
14258
|
-
label:
|
|
14258
|
+
label: "Please review your payment details",
|
|
14259
14259
|
order: 0
|
|
14260
14260
|
},
|
|
14261
14261
|
notes: {
|
|
14262
14262
|
enabled: true,
|
|
14263
|
-
header:
|
|
14263
|
+
header: "Additional Notes",
|
|
14264
14264
|
order: 0,
|
|
14265
|
-
placeholder:
|
|
14266
|
-
value:
|
|
14265
|
+
placeholder: "Enter any additional notes here",
|
|
14266
|
+
value: ""
|
|
14267
14267
|
},
|
|
14268
14268
|
page: {
|
|
14269
|
-
description:
|
|
14269
|
+
description: "Get paid securely",
|
|
14270
14270
|
enabled: true,
|
|
14271
|
-
header:
|
|
14271
|
+
header: "Payment Page",
|
|
14272
14272
|
order: 0
|
|
14273
14273
|
},
|
|
14274
14274
|
payment_button: {
|
|
14275
14275
|
enabled: true,
|
|
14276
|
-
label:
|
|
14276
|
+
label: "Pay Now",
|
|
14277
14277
|
order: 0
|
|
14278
14278
|
},
|
|
14279
14279
|
payment_methods: {
|
|
14280
14280
|
all_methods_checked: true,
|
|
14281
14281
|
enabled: true,
|
|
14282
|
-
header:
|
|
14282
|
+
header: "Payment Methods",
|
|
14283
14283
|
methods: {
|
|
14284
14284
|
amex: true,
|
|
14285
14285
|
apple_pay: true,
|
|
@@ -14296,27 +14296,27 @@ client.payment_link.add_pay_link_from_bill(
|
|
|
14296
14296
|
display: true,
|
|
14297
14297
|
fixed: true,
|
|
14298
14298
|
identifier: true,
|
|
14299
|
-
label:
|
|
14300
|
-
name:
|
|
14299
|
+
label: "Full Name",
|
|
14300
|
+
name: "fullName",
|
|
14301
14301
|
order: 0,
|
|
14302
14302
|
required: true,
|
|
14303
|
-
validation:
|
|
14304
|
-
value:
|
|
14303
|
+
validation: "alpha",
|
|
14304
|
+
value: "",
|
|
14305
14305
|
width: 0
|
|
14306
14306
|
}],
|
|
14307
|
-
header:
|
|
14307
|
+
header: "Payor Information",
|
|
14308
14308
|
order: 0
|
|
14309
14309
|
},
|
|
14310
14310
|
review: {
|
|
14311
14311
|
enabled: true,
|
|
14312
|
-
header:
|
|
14312
|
+
header: "Review Payment",
|
|
14313
14313
|
order: 0
|
|
14314
14314
|
},
|
|
14315
14315
|
settings: {
|
|
14316
14316
|
color: "#000000",
|
|
14317
|
-
language:
|
|
14317
|
+
language: "en"
|
|
14318
14318
|
}
|
|
14319
|
-
)
|
|
14319
|
+
)
|
|
14320
14320
|
```
|
|
14321
14321
|
</dd>
|
|
14322
14322
|
</dl>
|
|
@@ -14410,7 +14410,7 @@ Deletes a payment link by ID.
|
|
|
14410
14410
|
<dd>
|
|
14411
14411
|
|
|
14412
14412
|
```ruby
|
|
14413
|
-
client.payment_link.delete_pay_link_from_id(pay_link_id:
|
|
14413
|
+
client.payment_link.delete_pay_link_from_id(pay_link_id: "payLinkId")
|
|
14414
14414
|
```
|
|
14415
14415
|
</dd>
|
|
14416
14416
|
</dl>
|
|
@@ -14472,7 +14472,7 @@ Retrieves a payment link by ID.
|
|
|
14472
14472
|
<dd>
|
|
14473
14473
|
|
|
14474
14474
|
```ruby
|
|
14475
|
-
client.payment_link.get_pay_link_from_id(paylink_id:
|
|
14475
|
+
client.payment_link.get_pay_link_from_id(paylink_id: "paylinkId")
|
|
14476
14476
|
```
|
|
14477
14477
|
</dd>
|
|
14478
14478
|
</dl>
|
|
@@ -14534,7 +14534,7 @@ Send a payment link to the specified email addresses or phone numbers.
|
|
|
14534
14534
|
<dd>
|
|
14535
14535
|
|
|
14536
14536
|
```ruby
|
|
14537
|
-
client.payment_link.push_pay_link_from_id(pay_link_id:
|
|
14537
|
+
client.payment_link.push_pay_link_from_id(pay_link_id: "payLinkId")
|
|
14538
14538
|
```
|
|
14539
14539
|
</dd>
|
|
14540
14540
|
</dl>
|
|
@@ -14604,7 +14604,7 @@ Refresh a payment link's content after an update.
|
|
|
14604
14604
|
<dd>
|
|
14605
14605
|
|
|
14606
14606
|
```ruby
|
|
14607
|
-
client.payment_link.refresh_pay_link_from_id(pay_link_id:
|
|
14607
|
+
client.payment_link.refresh_pay_link_from_id(pay_link_id: "payLinkId")
|
|
14608
14608
|
```
|
|
14609
14609
|
</dd>
|
|
14610
14610
|
</dl>
|
|
@@ -14675,9 +14675,9 @@ Sends a payment link to the specified email addresses.
|
|
|
14675
14675
|
|
|
14676
14676
|
```ruby
|
|
14677
14677
|
client.payment_link.send_pay_link_from_id(
|
|
14678
|
-
pay_link_id:
|
|
14679
|
-
mail_2:
|
|
14680
|
-
)
|
|
14678
|
+
pay_link_id: "payLinkId",
|
|
14679
|
+
mail_2: "jo@example.com; ceo@example.com"
|
|
14680
|
+
)
|
|
14681
14681
|
```
|
|
14682
14682
|
</dd>
|
|
14683
14683
|
</dl>
|
|
@@ -14756,20 +14756,20 @@ Updates a payment link's details.
|
|
|
14756
14756
|
|
|
14757
14757
|
```ruby
|
|
14758
14758
|
client.payment_link.update_pay_link_from_id(
|
|
14759
|
-
pay_link_id:
|
|
14759
|
+
pay_link_id: "332-c277b704-1301",
|
|
14760
14760
|
notes: {
|
|
14761
14761
|
enabled: true,
|
|
14762
|
-
header:
|
|
14762
|
+
header: "Additional Notes",
|
|
14763
14763
|
order: 0,
|
|
14764
|
-
placeholder:
|
|
14765
|
-
value:
|
|
14764
|
+
placeholder: "Enter any additional notes here",
|
|
14765
|
+
value: ""
|
|
14766
14766
|
},
|
|
14767
14767
|
payment_button: {
|
|
14768
14768
|
enabled: true,
|
|
14769
|
-
label:
|
|
14769
|
+
label: "Pay Now",
|
|
14770
14770
|
order: 0
|
|
14771
14771
|
}
|
|
14772
|
-
)
|
|
14772
|
+
)
|
|
14773
14773
|
```
|
|
14774
14774
|
</dd>
|
|
14775
14775
|
</dl>
|
|
@@ -14904,18 +14904,18 @@ Generates a vendor payment link for a specific bill lot number. This allows you
|
|
|
14904
14904
|
|
|
14905
14905
|
```ruby
|
|
14906
14906
|
client.payment_link.add_pay_link_from_bill_lot_number(
|
|
14907
|
-
lot_number:
|
|
14908
|
-
entry_point:
|
|
14909
|
-
vendor_number:
|
|
14910
|
-
mail_2:
|
|
14911
|
-
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",
|
|
14912
14912
|
contact_us: {
|
|
14913
|
-
email_label:
|
|
14913
|
+
email_label: "Email",
|
|
14914
14914
|
enabled: true,
|
|
14915
|
-
header:
|
|
14915
|
+
header: "Contact Us",
|
|
14916
14916
|
order: 0,
|
|
14917
14917
|
payment_icons: true,
|
|
14918
|
-
phone_label:
|
|
14918
|
+
phone_label: "Phone"
|
|
14919
14919
|
},
|
|
14920
14920
|
logo: {
|
|
14921
14921
|
enabled: true,
|
|
@@ -14923,31 +14923,31 @@ client.payment_link.add_pay_link_from_bill_lot_number(
|
|
|
14923
14923
|
},
|
|
14924
14924
|
message_before_paying: {
|
|
14925
14925
|
enabled: true,
|
|
14926
|
-
label:
|
|
14926
|
+
label: "Please review your payment details",
|
|
14927
14927
|
order: 0
|
|
14928
14928
|
},
|
|
14929
14929
|
notes: {
|
|
14930
14930
|
enabled: true,
|
|
14931
|
-
header:
|
|
14931
|
+
header: "Additional Notes",
|
|
14932
14932
|
order: 0,
|
|
14933
|
-
placeholder:
|
|
14934
|
-
value:
|
|
14933
|
+
placeholder: "Enter any additional notes here",
|
|
14934
|
+
value: ""
|
|
14935
14935
|
},
|
|
14936
14936
|
page: {
|
|
14937
|
-
description:
|
|
14937
|
+
description: "Get paid securely",
|
|
14938
14938
|
enabled: true,
|
|
14939
|
-
header:
|
|
14939
|
+
header: "Payment Page",
|
|
14940
14940
|
order: 0
|
|
14941
14941
|
},
|
|
14942
14942
|
payment_button: {
|
|
14943
14943
|
enabled: true,
|
|
14944
|
-
label:
|
|
14944
|
+
label: "Pay Now",
|
|
14945
14945
|
order: 0
|
|
14946
14946
|
},
|
|
14947
14947
|
payment_methods: {
|
|
14948
14948
|
all_methods_checked: true,
|
|
14949
14949
|
enabled: true,
|
|
14950
|
-
header:
|
|
14950
|
+
header: "Payment Methods",
|
|
14951
14951
|
methods: {
|
|
14952
14952
|
amex: true,
|
|
14953
14953
|
apple_pay: true,
|
|
@@ -14964,27 +14964,27 @@ client.payment_link.add_pay_link_from_bill_lot_number(
|
|
|
14964
14964
|
display: true,
|
|
14965
14965
|
fixed: true,
|
|
14966
14966
|
identifier: true,
|
|
14967
|
-
label:
|
|
14968
|
-
name:
|
|
14967
|
+
label: "Full Name",
|
|
14968
|
+
name: "fullName",
|
|
14969
14969
|
order: 0,
|
|
14970
14970
|
required: true,
|
|
14971
|
-
validation:
|
|
14972
|
-
value:
|
|
14971
|
+
validation: "alpha",
|
|
14972
|
+
value: "",
|
|
14973
14973
|
width: 0
|
|
14974
14974
|
}],
|
|
14975
|
-
header:
|
|
14975
|
+
header: "Payor Information",
|
|
14976
14976
|
order: 0
|
|
14977
14977
|
},
|
|
14978
14978
|
review: {
|
|
14979
14979
|
enabled: true,
|
|
14980
|
-
header:
|
|
14980
|
+
header: "Review Payment",
|
|
14981
14981
|
order: 0
|
|
14982
14982
|
},
|
|
14983
14983
|
settings: {
|
|
14984
14984
|
color: "#000000",
|
|
14985
|
-
language:
|
|
14985
|
+
language: "en"
|
|
14986
14986
|
}
|
|
14987
|
-
)
|
|
14987
|
+
)
|
|
14988
14988
|
```
|
|
14989
14989
|
</dd>
|
|
14990
14990
|
</dl>
|
|
@@ -15088,16 +15088,16 @@ Add a payment method domain to an organization or paypoint.
|
|
|
15088
15088
|
|
|
15089
15089
|
```ruby
|
|
15090
15090
|
client.payment_method_domain.add_payment_method_domain(
|
|
15091
|
-
domain_name:
|
|
15091
|
+
domain_name: "checkout.example.com",
|
|
15092
15092
|
entity_id: 109,
|
|
15093
|
-
entity_type:
|
|
15093
|
+
entity_type: "paypoint",
|
|
15094
15094
|
apple_pay: {
|
|
15095
15095
|
is_enabled: true
|
|
15096
15096
|
},
|
|
15097
15097
|
google_pay: {
|
|
15098
15098
|
is_enabled: true
|
|
15099
15099
|
}
|
|
15100
|
-
)
|
|
15100
|
+
)
|
|
15101
15101
|
```
|
|
15102
15102
|
</dd>
|
|
15103
15103
|
</dl>
|
|
@@ -15191,7 +15191,7 @@ Cascades a payment method domain to all child entities. All paypoints and suborg
|
|
|
15191
15191
|
<dd>
|
|
15192
15192
|
|
|
15193
15193
|
```ruby
|
|
15194
|
-
client.payment_method_domain.cascade_payment_method_domain(domain_id:
|
|
15194
|
+
client.payment_method_domain.cascade_payment_method_domain(domain_id: "pmd_b8237fa45c964d8a9ef27160cd42b8c5")
|
|
15195
15195
|
```
|
|
15196
15196
|
</dd>
|
|
15197
15197
|
</dl>
|
|
@@ -15253,7 +15253,7 @@ Delete a payment method domain. You can't delete an inherited domain, you must d
|
|
|
15253
15253
|
<dd>
|
|
15254
15254
|
|
|
15255
15255
|
```ruby
|
|
15256
|
-
client.payment_method_domain.delete_payment_method_domain(domain_id:
|
|
15256
|
+
client.payment_method_domain.delete_payment_method_domain(domain_id: "pmd_b8237fa45c964d8a9ef27160cd42b8c5")
|
|
15257
15257
|
```
|
|
15258
15258
|
</dd>
|
|
15259
15259
|
</dl>
|
|
@@ -15315,7 +15315,7 @@ Get the details for a payment method domain.
|
|
|
15315
15315
|
<dd>
|
|
15316
15316
|
|
|
15317
15317
|
```ruby
|
|
15318
|
-
client.payment_method_domain.get_payment_method_domain(domain_id:
|
|
15318
|
+
client.payment_method_domain.get_payment_method_domain(domain_id: "pmd_b8237fa45c964d8a9ef27160cd42b8c5")
|
|
15319
15319
|
```
|
|
15320
15320
|
</dd>
|
|
15321
15321
|
</dl>
|
|
@@ -15379,8 +15379,8 @@ Get a list of payment method domains that belong to a PSP, organization, or payp
|
|
|
15379
15379
|
```ruby
|
|
15380
15380
|
client.payment_method_domain.list_payment_method_domains(
|
|
15381
15381
|
entity_id: 1147,
|
|
15382
|
-
entity_type:
|
|
15383
|
-
)
|
|
15382
|
+
entity_type: "paypoint"
|
|
15383
|
+
)
|
|
15384
15384
|
```
|
|
15385
15385
|
</dd>
|
|
15386
15386
|
</dl>
|
|
@@ -15475,14 +15475,14 @@ Update a payment method domain's configuration values.
|
|
|
15475
15475
|
|
|
15476
15476
|
```ruby
|
|
15477
15477
|
client.payment_method_domain.update_payment_method_domain(
|
|
15478
|
-
domain_id:
|
|
15478
|
+
domain_id: "pmd_b8237fa45c964d8a9ef27160cd42b8c5",
|
|
15479
15479
|
apple_pay: {
|
|
15480
15480
|
is_enabled: false
|
|
15481
15481
|
},
|
|
15482
15482
|
google_pay: {
|
|
15483
15483
|
is_enabled: false
|
|
15484
15484
|
}
|
|
15485
|
-
)
|
|
15485
|
+
)
|
|
15486
15486
|
```
|
|
15487
15487
|
</dd>
|
|
15488
15488
|
</dl>
|
|
@@ -15560,7 +15560,7 @@ Verify a new payment method domain. If verification is successful, Apple Pay is
|
|
|
15560
15560
|
<dd>
|
|
15561
15561
|
|
|
15562
15562
|
```ruby
|
|
15563
|
-
client.payment_method_domain.verify_payment_method_domain(domain_id:
|
|
15563
|
+
client.payment_method_domain.verify_payment_method_domain(domain_id: "pmd_b8237fa45c964d8a9ef27160cd42b8c5")
|
|
15564
15564
|
```
|
|
15565
15565
|
</dd>
|
|
15566
15566
|
</dl>
|
|
@@ -15623,7 +15623,7 @@ Gets the basic details for a paypoint.
|
|
|
15623
15623
|
<dd>
|
|
15624
15624
|
|
|
15625
15625
|
```ruby
|
|
15626
|
-
client.paypoint.get_basic_entry(entry:
|
|
15626
|
+
client.paypoint.get_basic_entry(entry: "8cfec329267")
|
|
15627
15627
|
```
|
|
15628
15628
|
</dd>
|
|
15629
15629
|
</dl>
|
|
@@ -15685,7 +15685,7 @@ Retrieves the basic details for a paypoint by ID.
|
|
|
15685
15685
|
<dd>
|
|
15686
15686
|
|
|
15687
15687
|
```ruby
|
|
15688
|
-
client.paypoint.get_basic_entry_by_id(id_paypoint:
|
|
15688
|
+
client.paypoint.get_basic_entry_by_id(id_paypoint: "198")
|
|
15689
15689
|
```
|
|
15690
15690
|
</dd>
|
|
15691
15691
|
</dl>
|
|
@@ -15747,7 +15747,7 @@ Gets the details for a single paypoint.
|
|
|
15747
15747
|
<dd>
|
|
15748
15748
|
|
|
15749
15749
|
```ruby
|
|
15750
|
-
client.paypoint.get_entry_config(entry:
|
|
15750
|
+
client.paypoint.get_entry_config(entry: "8cfec329267")
|
|
15751
15751
|
```
|
|
15752
15752
|
</dd>
|
|
15753
15753
|
</dl>
|
|
@@ -15818,9 +15818,9 @@ Gets the details for single payment page for a paypoint.
|
|
|
15818
15818
|
|
|
15819
15819
|
```ruby
|
|
15820
15820
|
client.paypoint.get_page(
|
|
15821
|
-
entry:
|
|
15822
|
-
subdomain:
|
|
15823
|
-
)
|
|
15821
|
+
entry: "8cfec329267",
|
|
15822
|
+
subdomain: "pay-your-fees-1"
|
|
15823
|
+
)
|
|
15824
15824
|
```
|
|
15825
15825
|
</dd>
|
|
15826
15826
|
</dl>
|
|
@@ -15891,9 +15891,9 @@ Deletes a payment page in a paypoint.
|
|
|
15891
15891
|
|
|
15892
15892
|
```ruby
|
|
15893
15893
|
client.paypoint.remove_page(
|
|
15894
|
-
entry:
|
|
15895
|
-
subdomain:
|
|
15896
|
-
)
|
|
15894
|
+
entry: "8cfec329267",
|
|
15895
|
+
subdomain: "pay-your-fees-1"
|
|
15896
|
+
)
|
|
15897
15897
|
```
|
|
15898
15898
|
</dd>
|
|
15899
15899
|
</dl>
|
|
@@ -15963,7 +15963,7 @@ Updates a paypoint logo.
|
|
|
15963
15963
|
<dd>
|
|
15964
15964
|
|
|
15965
15965
|
```ruby
|
|
15966
|
-
client.paypoint.save_logo(entry:
|
|
15966
|
+
client.paypoint.save_logo(entry: "8cfec329267")
|
|
15967
15967
|
```
|
|
15968
15968
|
</dd>
|
|
15969
15969
|
</dl>
|
|
@@ -16033,7 +16033,7 @@ Retrieves an paypoint's basic settings like custom fields, identifiers, and invo
|
|
|
16033
16033
|
<dd>
|
|
16034
16034
|
|
|
16035
16035
|
```ruby
|
|
16036
|
-
client.paypoint.settings_page(entry:
|
|
16036
|
+
client.paypoint.settings_page(entry: "8cfec329267")
|
|
16037
16037
|
```
|
|
16038
16038
|
</dd>
|
|
16039
16039
|
</dl>
|
|
@@ -16096,16 +16096,16 @@ Migrates a paypoint to a new parent organization.
|
|
|
16096
16096
|
|
|
16097
16097
|
```ruby
|
|
16098
16098
|
client.paypoint.migrate(
|
|
16099
|
-
entry_point:
|
|
16099
|
+
entry_point: "473abc123def",
|
|
16100
16100
|
new_parent_organization_id: 123,
|
|
16101
16101
|
notification_request: {
|
|
16102
|
-
notification_url:
|
|
16102
|
+
notification_url: "https://webhook-test.yoursie.com",
|
|
16103
16103
|
web_header_parameters: [{
|
|
16104
|
-
key:
|
|
16105
|
-
value:
|
|
16104
|
+
key: "testheader",
|
|
16105
|
+
value: "1234567890"
|
|
16106
16106
|
}]
|
|
16107
16107
|
}
|
|
16108
|
-
)
|
|
16108
|
+
)
|
|
16109
16109
|
```
|
|
16110
16110
|
</dd>
|
|
16111
16111
|
</dl>
|
|
@@ -16170,11 +16170,11 @@ unsettled transactions for a paypoint. Use filters to limit results. Include the
|
|
|
16170
16170
|
|
|
16171
16171
|
```ruby
|
|
16172
16172
|
client.query.list_batch_details(
|
|
16173
|
-
entry:
|
|
16173
|
+
entry: "8cfec329267",
|
|
16174
16174
|
from_record: 251,
|
|
16175
16175
|
limit_record: 0,
|
|
16176
|
-
sort_by:
|
|
16177
|
-
)
|
|
16176
|
+
sort_by: "desc(field_name)"
|
|
16177
|
+
)
|
|
16178
16178
|
```
|
|
16179
16179
|
</dd>
|
|
16180
16180
|
</dl>
|
|
@@ -16357,8 +16357,8 @@ client.query.list_batch_details_org(
|
|
|
16357
16357
|
org_id: 123,
|
|
16358
16358
|
from_record: 251,
|
|
16359
16359
|
limit_record: 0,
|
|
16360
|
-
sort_by:
|
|
16361
|
-
)
|
|
16360
|
+
sort_by: "desc(field_name)"
|
|
16361
|
+
)
|
|
16362
16362
|
```
|
|
16363
16363
|
</dd>
|
|
16364
16364
|
</dl>
|
|
@@ -16537,11 +16537,11 @@ Retrieve a list of batches for a paypoint. Use filters to limit results. Include
|
|
|
16537
16537
|
|
|
16538
16538
|
```ruby
|
|
16539
16539
|
client.query.list_batches(
|
|
16540
|
-
entry:
|
|
16540
|
+
entry: "8cfec329267",
|
|
16541
16541
|
from_record: 251,
|
|
16542
16542
|
limit_record: 0,
|
|
16543
|
-
sort_by:
|
|
16544
|
-
)
|
|
16543
|
+
sort_by: "desc(field_name)"
|
|
16544
|
+
)
|
|
16545
16545
|
```
|
|
16546
16546
|
</dd>
|
|
16547
16547
|
</dl>
|
|
@@ -16702,8 +16702,8 @@ client.query.list_batches_org(
|
|
|
16702
16702
|
org_id: 123,
|
|
16703
16703
|
from_record: 251,
|
|
16704
16704
|
limit_record: 0,
|
|
16705
|
-
sort_by:
|
|
16706
|
-
)
|
|
16705
|
+
sort_by: "desc(field_name)"
|
|
16706
|
+
)
|
|
16707
16707
|
```
|
|
16708
16708
|
</dd>
|
|
16709
16709
|
</dl>
|
|
@@ -16861,11 +16861,11 @@ Retrieve a list of MoneyOut batches for a paypoint. Use filters to limit results
|
|
|
16861
16861
|
|
|
16862
16862
|
```ruby
|
|
16863
16863
|
client.query.list_batches_out(
|
|
16864
|
-
entry:
|
|
16864
|
+
entry: "8cfec329267",
|
|
16865
16865
|
from_record: 251,
|
|
16866
16866
|
limit_record: 0,
|
|
16867
|
-
sort_by:
|
|
16868
|
-
)
|
|
16867
|
+
sort_by: "desc(field_name)"
|
|
16868
|
+
)
|
|
16869
16869
|
```
|
|
16870
16870
|
</dd>
|
|
16871
16871
|
</dl>
|
|
@@ -16988,8 +16988,8 @@ client.query.list_batches_out_org(
|
|
|
16988
16988
|
org_id: 123,
|
|
16989
16989
|
from_record: 251,
|
|
16990
16990
|
limit_record: 0,
|
|
16991
|
-
sort_by:
|
|
16992
|
-
)
|
|
16991
|
+
sort_by: "desc(field_name)"
|
|
16992
|
+
)
|
|
16993
16993
|
```
|
|
16994
16994
|
</dd>
|
|
16995
16995
|
</dl>
|
|
@@ -17124,11 +17124,11 @@ Retrieves a list of chargebacks and returned transactions for a paypoint. Use fi
|
|
|
17124
17124
|
|
|
17125
17125
|
```ruby
|
|
17126
17126
|
client.query.list_chargebacks(
|
|
17127
|
-
entry:
|
|
17127
|
+
entry: "8cfec329267",
|
|
17128
17128
|
from_record: 251,
|
|
17129
17129
|
limit_record: 0,
|
|
17130
|
-
sort_by:
|
|
17131
|
-
)
|
|
17130
|
+
sort_by: "desc(field_name)"
|
|
17131
|
+
)
|
|
17132
17132
|
```
|
|
17133
17133
|
</dd>
|
|
17134
17134
|
</dl>
|
|
@@ -17306,8 +17306,8 @@ client.query.list_chargebacks_org(
|
|
|
17306
17306
|
org_id: 123,
|
|
17307
17307
|
from_record: 251,
|
|
17308
17308
|
limit_record: 0,
|
|
17309
|
-
sort_by:
|
|
17310
|
-
)
|
|
17309
|
+
sort_by: "desc(field_name)"
|
|
17310
|
+
)
|
|
17311
17311
|
```
|
|
17312
17312
|
</dd>
|
|
17313
17313
|
</dl>
|
|
@@ -17484,11 +17484,11 @@ Retrieves a list of customers for a paypoint. Use filters to limit results. Incl
|
|
|
17484
17484
|
|
|
17485
17485
|
```ruby
|
|
17486
17486
|
client.query.list_customers(
|
|
17487
|
-
entry:
|
|
17487
|
+
entry: "8cfec329267",
|
|
17488
17488
|
from_record: 251,
|
|
17489
17489
|
limit_record: 0,
|
|
17490
|
-
sort_by:
|
|
17491
|
-
)
|
|
17490
|
+
sort_by: "desc(field_name)"
|
|
17491
|
+
)
|
|
17492
17492
|
```
|
|
17493
17493
|
</dd>
|
|
17494
17494
|
</dl>
|
|
@@ -17660,8 +17660,8 @@ client.query.list_customers_org(
|
|
|
17660
17660
|
org_id: 123,
|
|
17661
17661
|
from_record: 251,
|
|
17662
17662
|
limit_record: 0,
|
|
17663
|
-
sort_by:
|
|
17664
|
-
)
|
|
17663
|
+
sort_by: "desc(field_name)"
|
|
17664
|
+
)
|
|
17665
17665
|
```
|
|
17666
17666
|
</dd>
|
|
17667
17667
|
</dl>
|
|
@@ -17830,11 +17830,11 @@ Returns a list of all reports generated in the last 60 days for a single entrypo
|
|
|
17830
17830
|
|
|
17831
17831
|
```ruby
|
|
17832
17832
|
client.query.list_notification_reports(
|
|
17833
|
-
entry:
|
|
17833
|
+
entry: "8cfec329267",
|
|
17834
17834
|
from_record: 251,
|
|
17835
17835
|
limit_record: 0,
|
|
17836
|
-
sort_by:
|
|
17837
|
-
)
|
|
17836
|
+
sort_by: "desc(field_name)"
|
|
17837
|
+
)
|
|
17838
17838
|
```
|
|
17839
17839
|
</dd>
|
|
17840
17840
|
</dl>
|
|
@@ -17971,8 +17971,8 @@ client.query.list_notification_reports_org(
|
|
|
17971
17971
|
org_id: 123,
|
|
17972
17972
|
from_record: 251,
|
|
17973
17973
|
limit_record: 0,
|
|
17974
|
-
sort_by:
|
|
17975
|
-
)
|
|
17974
|
+
sort_by: "desc(field_name)"
|
|
17975
|
+
)
|
|
17976
17976
|
```
|
|
17977
17977
|
</dd>
|
|
17978
17978
|
</dl>
|
|
@@ -18104,11 +18104,11 @@ Returns a list of notifications for an entrypoint. Use filters to limit results.
|
|
|
18104
18104
|
|
|
18105
18105
|
```ruby
|
|
18106
18106
|
client.query.list_notifications(
|
|
18107
|
-
entry:
|
|
18107
|
+
entry: "8cfec329267",
|
|
18108
18108
|
from_record: 251,
|
|
18109
18109
|
limit_record: 0,
|
|
18110
|
-
sort_by:
|
|
18111
|
-
)
|
|
18110
|
+
sort_by: "desc(field_name)"
|
|
18111
|
+
)
|
|
18112
18112
|
```
|
|
18113
18113
|
</dd>
|
|
18114
18114
|
</dl>
|
|
@@ -18247,8 +18247,8 @@ client.query.list_notifications_org(
|
|
|
18247
18247
|
org_id: 123,
|
|
18248
18248
|
from_record: 251,
|
|
18249
18249
|
limit_record: 0,
|
|
18250
|
-
sort_by:
|
|
18251
|
-
)
|
|
18250
|
+
sort_by: "desc(field_name)"
|
|
18251
|
+
)
|
|
18252
18252
|
```
|
|
18253
18253
|
</dd>
|
|
18254
18254
|
</dl>
|
|
@@ -18387,8 +18387,8 @@ client.query.list_organizations(
|
|
|
18387
18387
|
org_id: 123,
|
|
18388
18388
|
from_record: 251,
|
|
18389
18389
|
limit_record: 0,
|
|
18390
|
-
sort_by:
|
|
18391
|
-
)
|
|
18390
|
+
sort_by: "desc(field_name)"
|
|
18391
|
+
)
|
|
18392
18392
|
```
|
|
18393
18393
|
</dd>
|
|
18394
18394
|
</dl>
|
|
@@ -18544,11 +18544,11 @@ Retrieves a list of money out transactions (payouts) for a paypoint. Use filters
|
|
|
18544
18544
|
|
|
18545
18545
|
```ruby
|
|
18546
18546
|
client.query.list_payout(
|
|
18547
|
-
entry:
|
|
18547
|
+
entry: "8cfec329267",
|
|
18548
18548
|
from_record: 251,
|
|
18549
18549
|
limit_record: 0,
|
|
18550
|
-
sort_by:
|
|
18551
|
-
)
|
|
18550
|
+
sort_by: "desc(field_name)"
|
|
18551
|
+
)
|
|
18552
18552
|
```
|
|
18553
18553
|
</dd>
|
|
18554
18554
|
</dl>
|
|
@@ -18734,8 +18734,8 @@ client.query.list_payout_org(
|
|
|
18734
18734
|
org_id: 123,
|
|
18735
18735
|
from_record: 251,
|
|
18736
18736
|
limit_record: 0,
|
|
18737
|
-
sort_by:
|
|
18738
|
-
)
|
|
18737
|
+
sort_by: "desc(field_name)"
|
|
18738
|
+
)
|
|
18739
18739
|
```
|
|
18740
18740
|
</dd>
|
|
18741
18741
|
</dl>
|
|
@@ -18920,8 +18920,8 @@ client.query.list_paypoints(
|
|
|
18920
18920
|
org_id: 123,
|
|
18921
18921
|
from_record: 251,
|
|
18922
18922
|
limit_record: 0,
|
|
18923
|
-
sort_by:
|
|
18924
|
-
)
|
|
18923
|
+
sort_by: "desc(field_name)"
|
|
18924
|
+
)
|
|
18925
18925
|
```
|
|
18926
18926
|
</dd>
|
|
18927
18927
|
</dl>
|
|
@@ -19082,11 +19082,11 @@ Retrieve a list of settled transactions for a paypoint. Use filters to limit res
|
|
|
19082
19082
|
|
|
19083
19083
|
```ruby
|
|
19084
19084
|
client.query.list_settlements(
|
|
19085
|
-
entry:
|
|
19085
|
+
entry: "8cfec329267",
|
|
19086
19086
|
from_record: 251,
|
|
19087
19087
|
limit_record: 0,
|
|
19088
|
-
sort_by:
|
|
19089
|
-
)
|
|
19088
|
+
sort_by: "desc(field_name)"
|
|
19089
|
+
)
|
|
19090
19090
|
```
|
|
19091
19091
|
</dd>
|
|
19092
19092
|
</dl>
|
|
@@ -19269,8 +19269,8 @@ client.query.list_settlements_org(
|
|
|
19269
19269
|
org_id: 123,
|
|
19270
19270
|
from_record: 251,
|
|
19271
19271
|
limit_record: 0,
|
|
19272
|
-
sort_by:
|
|
19273
|
-
)
|
|
19272
|
+
sort_by: "desc(field_name)"
|
|
19273
|
+
)
|
|
19274
19274
|
```
|
|
19275
19275
|
</dd>
|
|
19276
19276
|
</dl>
|
|
@@ -19450,11 +19450,11 @@ Returns a list of subscriptions for a single paypoint. Use filters to limit resu
|
|
|
19450
19450
|
|
|
19451
19451
|
```ruby
|
|
19452
19452
|
client.query.list_subscriptions(
|
|
19453
|
-
entry:
|
|
19453
|
+
entry: "8cfec329267",
|
|
19454
19454
|
from_record: 251,
|
|
19455
19455
|
limit_record: 0,
|
|
19456
|
-
sort_by:
|
|
19457
|
-
)
|
|
19456
|
+
sort_by: "desc(field_name)"
|
|
19457
|
+
)
|
|
19458
19458
|
```
|
|
19459
19459
|
</dd>
|
|
19460
19460
|
</dl>
|
|
@@ -19637,8 +19637,8 @@ client.query.list_subscriptions_org(
|
|
|
19637
19637
|
org_id: 123,
|
|
19638
19638
|
from_record: 251,
|
|
19639
19639
|
limit_record: 0,
|
|
19640
|
-
sort_by:
|
|
19641
|
-
)
|
|
19640
|
+
sort_by: "desc(field_name)"
|
|
19641
|
+
)
|
|
19642
19642
|
```
|
|
19643
19643
|
</dd>
|
|
19644
19644
|
</dl>
|
|
@@ -19825,11 +19825,11 @@ For example, this request parameters filter for transactions between April 01, 2
|
|
|
19825
19825
|
|
|
19826
19826
|
```ruby
|
|
19827
19827
|
client.query.list_transactions(
|
|
19828
|
-
entry:
|
|
19828
|
+
entry: "8cfec329267",
|
|
19829
19829
|
from_record: 251,
|
|
19830
19830
|
limit_record: 0,
|
|
19831
|
-
sort_by:
|
|
19832
|
-
)
|
|
19831
|
+
sort_by: "desc(field_name)"
|
|
19832
|
+
)
|
|
19833
19833
|
```
|
|
19834
19834
|
</dd>
|
|
19835
19835
|
</dl>
|
|
@@ -20034,8 +20034,8 @@ client.query.list_transactions_org(
|
|
|
20034
20034
|
org_id: 123,
|
|
20035
20035
|
from_record: 251,
|
|
20036
20036
|
limit_record: 0,
|
|
20037
|
-
sort_by:
|
|
20038
|
-
)
|
|
20037
|
+
sort_by: "desc(field_name)"
|
|
20038
|
+
)
|
|
20039
20039
|
```
|
|
20040
20040
|
</dd>
|
|
20041
20041
|
</dl>
|
|
@@ -20222,9 +20222,9 @@ Retrieve a list of transfer details records for a paypoint. Use filters to limit
|
|
|
20222
20222
|
|
|
20223
20223
|
```ruby
|
|
20224
20224
|
client.query.list_transfer_details(
|
|
20225
|
-
entry:
|
|
20225
|
+
entry: "47862acd",
|
|
20226
20226
|
transfer_id: 123456
|
|
20227
|
-
)
|
|
20227
|
+
)
|
|
20228
20228
|
```
|
|
20229
20229
|
</dd>
|
|
20230
20230
|
</dl>
|
|
@@ -20374,10 +20374,10 @@ Retrieve a list of transfers for a paypoint. Use filters to limit results. Inclu
|
|
|
20374
20374
|
|
|
20375
20375
|
```ruby
|
|
20376
20376
|
client.query.list_transfers(
|
|
20377
|
-
entry:
|
|
20377
|
+
entry: "47862acd",
|
|
20378
20378
|
from_record: 0,
|
|
20379
20379
|
limit_record: 20
|
|
20380
|
-
)
|
|
20380
|
+
)
|
|
20381
20381
|
```
|
|
20382
20382
|
</dd>
|
|
20383
20383
|
</dl>
|
|
@@ -20519,7 +20519,7 @@ client.query.list_transfers_org(
|
|
|
20519
20519
|
org_id: 123,
|
|
20520
20520
|
from_record: 0,
|
|
20521
20521
|
limit_record: 20
|
|
20522
|
-
)
|
|
20522
|
+
)
|
|
20523
20523
|
```
|
|
20524
20524
|
</dd>
|
|
20525
20525
|
</dl>
|
|
@@ -20658,7 +20658,7 @@ client.query.list_transfers_out_org(
|
|
|
20658
20658
|
org_id: 77,
|
|
20659
20659
|
from_record: 0,
|
|
20660
20660
|
limit_record: 20
|
|
20661
|
-
)
|
|
20661
|
+
)
|
|
20662
20662
|
```
|
|
20663
20663
|
</dd>
|
|
20664
20664
|
</dl>
|
|
@@ -20782,10 +20782,10 @@ Retrieve a list of outbound transfers for a paypoint. Use filters to limit resul
|
|
|
20782
20782
|
|
|
20783
20783
|
```ruby
|
|
20784
20784
|
client.query.list_transfers_out_paypoint(
|
|
20785
|
-
entry:
|
|
20785
|
+
entry: "47cade237",
|
|
20786
20786
|
from_record: 0,
|
|
20787
20787
|
limit_record: 20
|
|
20788
|
-
)
|
|
20788
|
+
)
|
|
20789
20789
|
```
|
|
20790
20790
|
</dd>
|
|
20791
20791
|
</dl>
|
|
@@ -20909,11 +20909,11 @@ Retrieve details for a specific outbound transfer. Use filters to limit results.
|
|
|
20909
20909
|
|
|
20910
20910
|
```ruby
|
|
20911
20911
|
client.query.list_transfer_details_out(
|
|
20912
|
-
entry:
|
|
20912
|
+
entry: "47ace2b25",
|
|
20913
20913
|
transfer_id: 4521,
|
|
20914
20914
|
from_record: 0,
|
|
20915
20915
|
limit_record: 20
|
|
20916
|
-
)
|
|
20916
|
+
)
|
|
20917
20917
|
```
|
|
20918
20918
|
</dd>
|
|
20919
20919
|
</dl>
|
|
@@ -21047,8 +21047,8 @@ client.query.list_users_org(
|
|
|
21047
21047
|
org_id: 123,
|
|
21048
21048
|
from_record: 251,
|
|
21049
21049
|
limit_record: 0,
|
|
21050
|
-
sort_by:
|
|
21051
|
-
)
|
|
21050
|
+
sort_by: "desc(field_name)"
|
|
21051
|
+
)
|
|
21052
21052
|
```
|
|
21053
21053
|
</dd>
|
|
21054
21054
|
</dl>
|
|
@@ -21186,11 +21186,11 @@ Get list of users for a paypoint. Use filters to limit results.
|
|
|
21186
21186
|
|
|
21187
21187
|
```ruby
|
|
21188
21188
|
client.query.list_users_paypoint(
|
|
21189
|
-
entry:
|
|
21189
|
+
entry: "8cfec329267",
|
|
21190
21190
|
from_record: 251,
|
|
21191
21191
|
limit_record: 0,
|
|
21192
|
-
sort_by:
|
|
21193
|
-
)
|
|
21192
|
+
sort_by: "desc(field_name)"
|
|
21193
|
+
)
|
|
21194
21194
|
```
|
|
21195
21195
|
</dd>
|
|
21196
21196
|
</dl>
|
|
@@ -21328,11 +21328,11 @@ Retrieve a list of vendors for an entrypoint. Use filters to limit results. Incl
|
|
|
21328
21328
|
|
|
21329
21329
|
```ruby
|
|
21330
21330
|
client.query.list_vendors(
|
|
21331
|
-
entry:
|
|
21331
|
+
entry: "8cfec329267",
|
|
21332
21332
|
from_record: 251,
|
|
21333
21333
|
limit_record: 0,
|
|
21334
|
-
sort_by:
|
|
21335
|
-
)
|
|
21334
|
+
sort_by: "desc(field_name)"
|
|
21335
|
+
)
|
|
21336
21336
|
```
|
|
21337
21337
|
</dd>
|
|
21338
21338
|
</dl>
|
|
@@ -21493,8 +21493,8 @@ client.query.list_vendors_org(
|
|
|
21493
21493
|
org_id: 123,
|
|
21494
21494
|
from_record: 251,
|
|
21495
21495
|
limit_record: 0,
|
|
21496
|
-
sort_by:
|
|
21497
|
-
)
|
|
21496
|
+
sort_by: "desc(field_name)"
|
|
21497
|
+
)
|
|
21498
21498
|
```
|
|
21499
21499
|
</dd>
|
|
21500
21500
|
</dl>
|
|
@@ -21652,11 +21652,11 @@ Retrieve a list of vcards (virtual credit cards) issued for an entrypoint. Use f
|
|
|
21652
21652
|
|
|
21653
21653
|
```ruby
|
|
21654
21654
|
client.query.list_vcards(
|
|
21655
|
-
entry:
|
|
21655
|
+
entry: "8cfec329267",
|
|
21656
21656
|
from_record: 251,
|
|
21657
21657
|
limit_record: 0,
|
|
21658
|
-
sort_by:
|
|
21659
|
-
)
|
|
21658
|
+
sort_by: "desc(field_name)"
|
|
21659
|
+
)
|
|
21660
21660
|
```
|
|
21661
21661
|
</dd>
|
|
21662
21662
|
</dl>
|
|
@@ -21809,8 +21809,8 @@ client.query.list_vcards_org(
|
|
|
21809
21809
|
org_id: 123,
|
|
21810
21810
|
from_record: 251,
|
|
21811
21811
|
limit_record: 0,
|
|
21812
|
-
sort_by:
|
|
21813
|
-
)
|
|
21812
|
+
sort_by: "desc(field_name)"
|
|
21813
|
+
)
|
|
21814
21814
|
```
|
|
21815
21815
|
</dd>
|
|
21816
21816
|
</dl>
|
|
@@ -21962,12 +21962,12 @@ Retrieves the basic statistics for an organization or a paypoint, for a given ti
|
|
|
21962
21962
|
```ruby
|
|
21963
21963
|
client.statistic.basic_stats(
|
|
21964
21964
|
entry_id: 1000000,
|
|
21965
|
-
freq:
|
|
21965
|
+
freq: "m",
|
|
21966
21966
|
level: 1,
|
|
21967
|
-
mode:
|
|
21968
|
-
end_date:
|
|
21969
|
-
start_date:
|
|
21970
|
-
)
|
|
21967
|
+
mode: "ytd",
|
|
21968
|
+
end_date: "2025-11-01",
|
|
21969
|
+
start_date: "2025-11-30"
|
|
21970
|
+
)
|
|
21971
21971
|
```
|
|
21972
21972
|
</dd>
|
|
21973
21973
|
</dl>
|
|
@@ -22122,9 +22122,9 @@ Retrieves the basic statistics for a customer for a specific time period, groupe
|
|
|
22122
22122
|
```ruby
|
|
22123
22123
|
client.statistic.customer_basic_stats(
|
|
22124
22124
|
customer_id: 998,
|
|
22125
|
-
freq:
|
|
22126
|
-
mode:
|
|
22127
|
-
)
|
|
22125
|
+
freq: "m",
|
|
22126
|
+
mode: "ytd"
|
|
22127
|
+
)
|
|
22128
22128
|
```
|
|
22129
22129
|
</dd>
|
|
22130
22130
|
</dl>
|
|
@@ -22235,9 +22235,9 @@ Retrieves the subscription statistics for a given interval for a paypoint or org
|
|
|
22235
22235
|
```ruby
|
|
22236
22236
|
client.statistic.sub_stats(
|
|
22237
22237
|
entry_id: 1000000,
|
|
22238
|
-
interval:
|
|
22238
|
+
interval: "30",
|
|
22239
22239
|
level: 1
|
|
22240
|
-
)
|
|
22240
|
+
)
|
|
22241
22241
|
```
|
|
22242
22242
|
</dd>
|
|
22243
22243
|
</dl>
|
|
@@ -22336,10 +22336,10 @@ Retrieve the basic statistics about a vendor for a given time period, grouped by
|
|
|
22336
22336
|
|
|
22337
22337
|
```ruby
|
|
22338
22338
|
client.statistic.vendor_basic_stats(
|
|
22339
|
-
freq:
|
|
22339
|
+
freq: "m",
|
|
22340
22340
|
id_vendor: 1,
|
|
22341
|
-
mode:
|
|
22342
|
-
)
|
|
22341
|
+
mode: "ytd"
|
|
22342
|
+
)
|
|
22343
22343
|
```
|
|
22344
22344
|
</dd>
|
|
22345
22345
|
</dl>
|
|
@@ -22449,7 +22449,7 @@ Retrieves a single subscription's details.
|
|
|
22449
22449
|
<dd>
|
|
22450
22450
|
|
|
22451
22451
|
```ruby
|
|
22452
|
-
client.subscription.get_subscription(sub_id: 263)
|
|
22452
|
+
client.subscription.get_subscription(sub_id: 263)
|
|
22453
22453
|
```
|
|
22454
22454
|
</dd>
|
|
22455
22455
|
</dl>
|
|
@@ -22515,27 +22515,27 @@ client.subscription.new_subscription(
|
|
|
22515
22515
|
customer_data: {
|
|
22516
22516
|
customer_id: 4440
|
|
22517
22517
|
},
|
|
22518
|
-
entry_point:
|
|
22518
|
+
entry_point: "f743aed24a",
|
|
22519
22519
|
payment_details: {
|
|
22520
22520
|
service_fee: 0,
|
|
22521
22521
|
total_amount: 100
|
|
22522
22522
|
},
|
|
22523
22523
|
payment_method: {
|
|
22524
|
-
cardcvv:
|
|
22525
|
-
cardexp:
|
|
22526
|
-
card_holder:
|
|
22527
|
-
cardnumber:
|
|
22528
|
-
cardzip:
|
|
22529
|
-
initiator:
|
|
22530
|
-
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"
|
|
22531
22531
|
},
|
|
22532
22532
|
schedule_details: {
|
|
22533
|
-
end_date:
|
|
22534
|
-
frequency:
|
|
22533
|
+
end_date: "03-20-2025",
|
|
22534
|
+
frequency: "weekly",
|
|
22535
22535
|
plan_id: 1,
|
|
22536
|
-
start_date:
|
|
22536
|
+
start_date: "09-20-2024"
|
|
22537
22537
|
}
|
|
22538
|
-
)
|
|
22538
|
+
)
|
|
22539
22539
|
```
|
|
22540
22540
|
</dd>
|
|
22541
22541
|
</dl>
|
|
@@ -22613,7 +22613,7 @@ Deletes a subscription, autopay, or recurring payment and prevents future charge
|
|
|
22613
22613
|
<dd>
|
|
22614
22614
|
|
|
22615
22615
|
```ruby
|
|
22616
|
-
client.subscription.remove_subscription(sub_id: 396)
|
|
22616
|
+
client.subscription.remove_subscription(sub_id: 396)
|
|
22617
22617
|
```
|
|
22618
22618
|
</dd>
|
|
22619
22619
|
</dl>
|
|
@@ -22678,7 +22678,7 @@ Updates a subscription's details.
|
|
|
22678
22678
|
client.subscription.update_subscription(
|
|
22679
22679
|
sub_id: 231,
|
|
22680
22680
|
set_pause: true
|
|
22681
|
-
)
|
|
22681
|
+
)
|
|
22682
22682
|
```
|
|
22683
22683
|
</dd>
|
|
22684
22684
|
</dl>
|
|
@@ -22765,7 +22765,7 @@ Deletes a template by ID.
|
|
|
22765
22765
|
<dd>
|
|
22766
22766
|
|
|
22767
22767
|
```ruby
|
|
22768
|
-
client.templates.delete_template(template_id: 80)
|
|
22768
|
+
client.templates.delete_template(template_id: 80)
|
|
22769
22769
|
```
|
|
22770
22770
|
</dd>
|
|
22771
22771
|
</dl>
|
|
@@ -22830,7 +22830,7 @@ Generates a boarding link from a boarding template.
|
|
|
22830
22830
|
client.templates.getlink_template(
|
|
22831
22831
|
ignore_empty: true,
|
|
22832
22832
|
template_id: 80
|
|
22833
|
-
)
|
|
22833
|
+
)
|
|
22834
22834
|
```
|
|
22835
22835
|
</dd>
|
|
22836
22836
|
</dl>
|
|
@@ -22900,7 +22900,7 @@ Retrieves a boarding template's details by ID.
|
|
|
22900
22900
|
<dd>
|
|
22901
22901
|
|
|
22902
22902
|
```ruby
|
|
22903
|
-
client.templates.get_template(template_id: 80)
|
|
22903
|
+
client.templates.get_template(template_id: 80)
|
|
22904
22904
|
```
|
|
22905
22905
|
</dd>
|
|
22906
22906
|
</dl>
|
|
@@ -22966,8 +22966,8 @@ client.templates.list_templates(
|
|
|
22966
22966
|
org_id: 123,
|
|
22967
22967
|
from_record: 251,
|
|
22968
22968
|
limit_record: 0,
|
|
22969
|
-
sort_by:
|
|
22970
|
-
)
|
|
22969
|
+
sort_by: "desc(field_name)"
|
|
22970
|
+
)
|
|
22971
22971
|
```
|
|
22972
22972
|
</dd>
|
|
22973
22973
|
</dl>
|
|
@@ -23111,17 +23111,17 @@ client.token_storage.add_method(
|
|
|
23111
23111
|
customer_data: {
|
|
23112
23112
|
customer_id: 4440
|
|
23113
23113
|
},
|
|
23114
|
-
entry_point:
|
|
23114
|
+
entry_point: "f743aed24a",
|
|
23115
23115
|
fallback_auth: true,
|
|
23116
23116
|
payment_method: {
|
|
23117
|
-
cardcvv:
|
|
23118
|
-
cardexp:
|
|
23119
|
-
card_holder:
|
|
23120
|
-
cardnumber:
|
|
23121
|
-
cardzip:
|
|
23122
|
-
method_:
|
|
23117
|
+
cardcvv: "123",
|
|
23118
|
+
cardexp: "02/25",
|
|
23119
|
+
card_holder: "John Doe",
|
|
23120
|
+
cardnumber: "4111111111111111",
|
|
23121
|
+
cardzip: "12345",
|
|
23122
|
+
method_: "card"
|
|
23123
23123
|
}
|
|
23124
|
-
)
|
|
23124
|
+
)
|
|
23125
23125
|
```
|
|
23126
23126
|
</dd>
|
|
23127
23127
|
</dl>
|
|
@@ -23224,10 +23224,10 @@ Retrieves details for a saved payment method.
|
|
|
23224
23224
|
|
|
23225
23225
|
```ruby
|
|
23226
23226
|
client.token_storage.get_method(
|
|
23227
|
-
method_id:
|
|
23227
|
+
method_id: "32-8877drt00045632-678",
|
|
23228
23228
|
card_expiration_format: 1,
|
|
23229
23229
|
include_temporary: false
|
|
23230
|
-
)
|
|
23230
|
+
)
|
|
23231
23231
|
```
|
|
23232
23232
|
</dd>
|
|
23233
23233
|
</dl>
|
|
@@ -23315,7 +23315,7 @@ Deletes a saved payment method.
|
|
|
23315
23315
|
<dd>
|
|
23316
23316
|
|
|
23317
23317
|
```ruby
|
|
23318
|
-
client.token_storage.remove_method(method_id:
|
|
23318
|
+
client.token_storage.remove_method(method_id: "32-8877drt00045632-678")
|
|
23319
23319
|
```
|
|
23320
23320
|
</dd>
|
|
23321
23321
|
</dl>
|
|
@@ -23378,21 +23378,21 @@ Updates a saved payment method.
|
|
|
23378
23378
|
|
|
23379
23379
|
```ruby
|
|
23380
23380
|
client.token_storage.update_method(
|
|
23381
|
-
method_id:
|
|
23381
|
+
method_id: "32-8877drt00045632-678",
|
|
23382
23382
|
customer_data: {
|
|
23383
23383
|
customer_id: 4440
|
|
23384
23384
|
},
|
|
23385
|
-
entry_point:
|
|
23385
|
+
entry_point: "f743aed24a",
|
|
23386
23386
|
fallback_auth: true,
|
|
23387
23387
|
payment_method: {
|
|
23388
|
-
cardcvv:
|
|
23389
|
-
cardexp:
|
|
23390
|
-
card_holder:
|
|
23391
|
-
cardnumber:
|
|
23392
|
-
cardzip:
|
|
23393
|
-
method_:
|
|
23388
|
+
cardcvv: "123",
|
|
23389
|
+
cardexp: "02/25",
|
|
23390
|
+
card_holder: "John Doe",
|
|
23391
|
+
cardnumber: "4111111111111111",
|
|
23392
|
+
cardzip: "12345",
|
|
23393
|
+
method_: "card"
|
|
23394
23394
|
}
|
|
23395
|
-
)
|
|
23395
|
+
)
|
|
23396
23396
|
```
|
|
23397
23397
|
</dd>
|
|
23398
23398
|
</dl>
|
|
@@ -23471,7 +23471,7 @@ Use this endpoint to add a new user to an organization.
|
|
|
23471
23471
|
<dd>
|
|
23472
23472
|
|
|
23473
23473
|
```ruby
|
|
23474
|
-
client.user.add_user
|
|
23474
|
+
client.user.add_user
|
|
23475
23475
|
```
|
|
23476
23476
|
</dd>
|
|
23477
23477
|
</dl>
|
|
@@ -23533,7 +23533,7 @@ Use this endpoint to refresh the authentication token for a user within an organ
|
|
|
23533
23533
|
<dd>
|
|
23534
23534
|
|
|
23535
23535
|
```ruby
|
|
23536
|
-
client.user.auth_refresh_user
|
|
23536
|
+
client.user.auth_refresh_user
|
|
23537
23537
|
```
|
|
23538
23538
|
</dd>
|
|
23539
23539
|
</dl>
|
|
@@ -23587,7 +23587,7 @@ Use this endpoint to initiate a password reset for a user within an organization
|
|
|
23587
23587
|
<dd>
|
|
23588
23588
|
|
|
23589
23589
|
```ruby
|
|
23590
|
-
client.user.auth_reset_user
|
|
23590
|
+
client.user.auth_reset_user
|
|
23591
23591
|
```
|
|
23592
23592
|
</dd>
|
|
23593
23593
|
</dl>
|
|
@@ -23665,7 +23665,7 @@ This endpoint requires an application API token.
|
|
|
23665
23665
|
<dd>
|
|
23666
23666
|
|
|
23667
23667
|
```ruby
|
|
23668
|
-
client.user.auth_user(provider:
|
|
23668
|
+
client.user.auth_user(provider: "provider")
|
|
23669
23669
|
```
|
|
23670
23670
|
</dd>
|
|
23671
23671
|
</dl>
|
|
@@ -23775,7 +23775,7 @@ Use this endpoint to change the password for a user within an organization.
|
|
|
23775
23775
|
<dd>
|
|
23776
23776
|
|
|
23777
23777
|
```ruby
|
|
23778
|
-
client.user.change_psw_user
|
|
23778
|
+
client.user.change_psw_user
|
|
23779
23779
|
```
|
|
23780
23780
|
</dd>
|
|
23781
23781
|
</dl>
|
|
@@ -23837,7 +23837,7 @@ Use this endpoint to delete a specific user within an organization.
|
|
|
23837
23837
|
<dd>
|
|
23838
23838
|
|
|
23839
23839
|
```ruby
|
|
23840
|
-
client.user.delete_user(user_id: 1000000)
|
|
23840
|
+
client.user.delete_user(user_id: 1000000)
|
|
23841
23841
|
```
|
|
23842
23842
|
</dd>
|
|
23843
23843
|
</dl>
|
|
@@ -23899,7 +23899,7 @@ Use this endpoint to enable or disable multi-factor authentication (MFA) for a u
|
|
|
23899
23899
|
<dd>
|
|
23900
23900
|
|
|
23901
23901
|
```ruby
|
|
23902
|
-
client.user.edit_mfa_user(user_id: 1000000)
|
|
23902
|
+
client.user.edit_mfa_user(user_id: 1000000)
|
|
23903
23903
|
```
|
|
23904
23904
|
</dd>
|
|
23905
23905
|
</dl>
|
|
@@ -23969,7 +23969,7 @@ Use this endpoint to modify the details of a specific user within an organizatio
|
|
|
23969
23969
|
<dd>
|
|
23970
23970
|
|
|
23971
23971
|
```ruby
|
|
23972
|
-
client.user.edit_user(user_id: 1000000)
|
|
23972
|
+
client.user.edit_user(user_id: 1000000)
|
|
23973
23973
|
```
|
|
23974
23974
|
</dd>
|
|
23975
23975
|
</dl>
|
|
@@ -24041,8 +24041,8 @@ Use this endpoint to retrieve information about a specific user within an organi
|
|
|
24041
24041
|
```ruby
|
|
24042
24042
|
client.user.get_user(
|
|
24043
24043
|
user_id: 1000000,
|
|
24044
|
-
entry:
|
|
24045
|
-
)
|
|
24044
|
+
entry: "478ae1234"
|
|
24045
|
+
)
|
|
24046
24046
|
```
|
|
24047
24047
|
</dd>
|
|
24048
24048
|
</dl>
|
|
@@ -24120,7 +24120,7 @@ Use this endpoint to log a user out from the system.
|
|
|
24120
24120
|
<dd>
|
|
24121
24121
|
|
|
24122
24122
|
```ruby
|
|
24123
|
-
client.user.logout_user
|
|
24123
|
+
client.user.logout_user
|
|
24124
24124
|
```
|
|
24125
24125
|
</dd>
|
|
24126
24126
|
</dl>
|
|
@@ -24175,10 +24175,10 @@ Resends the MFA code to the user via the selected MFA mode (email or SMS).
|
|
|
24175
24175
|
|
|
24176
24176
|
```ruby
|
|
24177
24177
|
client.user.resend_mfa_code(
|
|
24178
|
-
entry:
|
|
24178
|
+
entry: "Entry",
|
|
24179
24179
|
entry_type: 1,
|
|
24180
|
-
usrname:
|
|
24181
|
-
)
|
|
24180
|
+
usrname: "usrname"
|
|
24181
|
+
)
|
|
24182
24182
|
```
|
|
24183
24183
|
</dd>
|
|
24184
24184
|
</dl>
|
|
@@ -24256,7 +24256,7 @@ Use this endpoint to validate the multi-factor authentication (MFA) code for a u
|
|
|
24256
24256
|
<dd>
|
|
24257
24257
|
|
|
24258
24258
|
```ruby
|
|
24259
|
-
client.user.validate_mfa_user
|
|
24259
|
+
client.user.validate_mfa_user
|
|
24260
24260
|
```
|
|
24261
24261
|
</dd>
|
|
24262
24262
|
</dl>
|
|
@@ -24328,50 +24328,50 @@ Creates a vendor in an entrypoint.
|
|
|
24328
24328
|
|
|
24329
24329
|
```ruby
|
|
24330
24330
|
client.vendor.add_vendor(
|
|
24331
|
-
entry:
|
|
24332
|
-
vendor_number:
|
|
24333
|
-
address_1:
|
|
24334
|
-
address_2:
|
|
24331
|
+
entry: "8cfec329267",
|
|
24332
|
+
vendor_number: "1234",
|
|
24333
|
+
address_1: "123 Ocean Drive",
|
|
24334
|
+
address_2: "Suite 400",
|
|
24335
24335
|
billing_data: {
|
|
24336
24336
|
id: 123,
|
|
24337
|
-
bank_name:
|
|
24338
|
-
routing_account:
|
|
24339
|
-
account_number:
|
|
24340
|
-
type_account:
|
|
24341
|
-
bank_account_holder_name:
|
|
24342
|
-
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",
|
|
24343
24343
|
bank_account_function: 0
|
|
24344
24344
|
},
|
|
24345
|
-
city:
|
|
24345
|
+
city: "Miami",
|
|
24346
24346
|
contacts: [{
|
|
24347
|
-
contact_name:
|
|
24348
|
-
contact_email:
|
|
24349
|
-
contact_title:
|
|
24350
|
-
contact_phone:
|
|
24347
|
+
contact_name: "Herman Martinez",
|
|
24348
|
+
contact_email: "example@email.com",
|
|
24349
|
+
contact_title: "Owner",
|
|
24350
|
+
contact_phone: "3055550000"
|
|
24351
24351
|
}],
|
|
24352
|
-
country:
|
|
24353
|
-
customer_vendor_account:
|
|
24354
|
-
ein:
|
|
24355
|
-
email:
|
|
24352
|
+
country: "US",
|
|
24353
|
+
customer_vendor_account: "A-37622",
|
|
24354
|
+
ein: "12-3456789",
|
|
24355
|
+
email: "example@email.com",
|
|
24356
24356
|
internal_reference_id: 123,
|
|
24357
|
-
location_code:
|
|
24358
|
-
mcc:
|
|
24357
|
+
location_code: "MIA123",
|
|
24358
|
+
mcc: "7777",
|
|
24359
24359
|
name_1: "Herman's Coatings and Masonry",
|
|
24360
|
-
name_2:
|
|
24361
|
-
payee_name_1:
|
|
24362
|
-
payee_name_2:
|
|
24363
|
-
payment_method:
|
|
24364
|
-
phone:
|
|
24365
|
-
remit_address_1:
|
|
24366
|
-
remit_address_2:
|
|
24367
|
-
remit_city:
|
|
24368
|
-
remit_country:
|
|
24369
|
-
remit_state:
|
|
24370
|
-
remit_zip:
|
|
24371
|
-
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",
|
|
24372
24372
|
vendor_status: 1,
|
|
24373
|
-
zip:
|
|
24374
|
-
)
|
|
24373
|
+
zip: "33139"
|
|
24374
|
+
)
|
|
24375
24375
|
```
|
|
24376
24376
|
</dd>
|
|
24377
24377
|
</dl>
|
|
@@ -24441,7 +24441,7 @@ Delete a vendor.
|
|
|
24441
24441
|
<dd>
|
|
24442
24442
|
|
|
24443
24443
|
```ruby
|
|
24444
|
-
client.vendor.delete_vendor(id_vendor: 1)
|
|
24444
|
+
client.vendor.delete_vendor(id_vendor: 1)
|
|
24445
24445
|
```
|
|
24446
24446
|
</dd>
|
|
24447
24447
|
</dl>
|
|
@@ -24506,7 +24506,7 @@ Updates a vendor's information. Send only the fields you need to update.
|
|
|
24506
24506
|
client.vendor.edit_vendor(
|
|
24507
24507
|
id_vendor: 1,
|
|
24508
24508
|
name_1: "Theodore's Janitorial"
|
|
24509
|
-
)
|
|
24509
|
+
)
|
|
24510
24510
|
```
|
|
24511
24511
|
</dd>
|
|
24512
24512
|
</dl>
|
|
@@ -24576,7 +24576,7 @@ Retrieves a vendor's details.
|
|
|
24576
24576
|
<dd>
|
|
24577
24577
|
|
|
24578
24578
|
```ruby
|
|
24579
|
-
client.vendor.get_vendor(id_vendor: 1)
|
|
24579
|
+
client.vendor.get_vendor(id_vendor: 1)
|
|
24580
24580
|
```
|
|
24581
24581
|
</dd>
|
|
24582
24582
|
</dl>
|
|
@@ -24643,7 +24643,7 @@ client.wallet.configure_apple_pay_organization(
|
|
|
24643
24643
|
cascade: true,
|
|
24644
24644
|
is_enabled: true,
|
|
24645
24645
|
org_id: 901
|
|
24646
|
-
)
|
|
24646
|
+
)
|
|
24647
24647
|
```
|
|
24648
24648
|
</dd>
|
|
24649
24649
|
</dl>
|
|
@@ -24722,9 +24722,9 @@ Configure and activate Apple Pay for a Payabli paypoint
|
|
|
24722
24722
|
|
|
24723
24723
|
```ruby
|
|
24724
24724
|
client.wallet.configure_apple_pay_paypoint(
|
|
24725
|
-
entry:
|
|
24725
|
+
entry: "8cfec329267",
|
|
24726
24726
|
is_enabled: true
|
|
24727
|
-
)
|
|
24727
|
+
)
|
|
24728
24728
|
```
|
|
24729
24729
|
</dd>
|
|
24730
24730
|
</dl>
|
|
@@ -24798,7 +24798,7 @@ client.wallet.configure_google_pay_organization(
|
|
|
24798
24798
|
cascade: true,
|
|
24799
24799
|
is_enabled: true,
|
|
24800
24800
|
org_id: 901
|
|
24801
|
-
)
|
|
24801
|
+
)
|
|
24802
24802
|
```
|
|
24803
24803
|
</dd>
|
|
24804
24804
|
</dl>
|
|
@@ -24877,9 +24877,9 @@ Configure and activate Google Pay for a Payabli paypoint
|
|
|
24877
24877
|
|
|
24878
24878
|
```ruby
|
|
24879
24879
|
client.wallet.configure_google_pay_paypoint(
|
|
24880
|
-
entry:
|
|
24880
|
+
entry: "8cfec329267",
|
|
24881
24881
|
is_enabled: true
|
|
24882
|
-
)
|
|
24882
|
+
)
|
|
24883
24883
|
```
|
|
24884
24884
|
</dd>
|
|
24885
24885
|
</dl>
|