payabli 3.0.0 → 3.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.fern/metadata.json +4 -4
- data/lib/payabli/client.rb +6 -1
- data/lib/payabli/funding/client.rb +49 -0
- data/lib/payabli/funding/types/deposit_funds_request.rb +19 -0
- data/lib/payabli/money_in/client.rb +79 -35
- data/lib/payabli/money_out/client.rb +56 -1
- data/lib/payabli/money_out/types/renew_v_card_request.rb +13 -0
- data/lib/payabli/payment_link/client.rb +7 -0
- data/lib/payabli/payment_link/types/pay_link_data_invoice.rb +1 -1
- data/lib/payabli/types/auth_capture_payout_response_data.rb +2 -0
- data/lib/payabli/types/authorize_payment_method.rb +4 -0
- data/lib/payabli/types/bill_detail_response.rb +6 -2
- data/lib/payabli/types/cancel_payout_response_data.rb +27 -0
- data/lib/payabli/types/capture_all_out_response_response_data_item.rb +2 -0
- data/lib/payabli/types/deposit_funds_response.rb +16 -0
- data/lib/payabli/types/entity_id_string.rb +23 -0
- data/lib/payabli/types/method_element.rb +4 -0
- data/lib/payabli/types/methods_list.rb +6 -0
- data/lib/payabli/types/payabli_api_response_0000.rb +1 -1
- data/lib/payabli/types/query_response_settlements_records_item.rb +2 -0
- data/lib/payabli/types/refund_v_2_request.rb +21 -0
- data/lib/payabli/types/renew_v_card_response.rb +13 -0
- data/lib/payabli/types/renew_v_card_response_data.rb +25 -0
- data/lib/payabli/types/settlement_split_funding_detail.rb +23 -0
- data/lib/payabli/types/settlement_status_name.rb +23 -0
- data/lib/payabli/types/stat_basic_extended_query_record.rb +8 -0
- data/lib/payabli/types/transfer_out_record.rb +4 -0
- data/lib/payabli/types/vendor_call_status_completed.rb +20 -0
- data/lib/payabli/types/vendor_call_status_extracted_data.rb +12 -0
- data/lib/payabli/types/vendor_call_status_failed.rb +18 -0
- data/lib/payabli/types/vendor_call_status_response.rb +18 -0
- data/lib/payabli/types/vendor_call_status_scheduled.rb +14 -0
- data/lib/payabli/types/vendor_data.rb +1 -1
- data/lib/payabli/types/vendor_query_record.rb +1 -1
- data/lib/payabli/types/vendor_schedule_call_response.rb +20 -0
- data/lib/payabli/types/vendor_schedule_call_response_data.rb +16 -0
- data/lib/payabli/types/vendoridtrans.rb +23 -0
- data/lib/payabli/vendor/client.rb +79 -0
- data/lib/payabli/vendor/types/schedule_enrichment_call_request.rb +27 -0
- data/lib/payabli/version.rb +1 -1
- data/lib/payabli.rb +20 -0
- data/reference.md +456 -38
- data/wiremock/wiremock-mappings.json +160 -21
- metadata +22 -2
data/reference.md
CHANGED
|
@@ -1580,11 +1580,14 @@ client.check_capture.check_processing(
|
|
|
1580
1580
|
<dl>
|
|
1581
1581
|
<dd>
|
|
1582
1582
|
|
|
1583
|
+
<Warning>
|
|
1584
|
+
This endpoint is deprecated. New integrations should use the [Authorize endpoint](/developers/api-reference/moneyinV2/authorize-a-transaction), then capture, void, or refund the resulting transaction with the corresponding endpoints. Transactions created with this legacy endpoint must be managed with the legacy lifecycle endpoints — they aren't interchangeable with the current ones.
|
|
1585
|
+
</Warning>
|
|
1586
|
+
|
|
1587
|
+
|
|
1583
1588
|
Authorize a card transaction. This returns an authorization code and reserves funds for the merchant. Authorized transactions aren't flagged for settlement until [captured](/developers/api-reference/moneyin/capture-an-authorized-transaction).
|
|
1589
|
+
|
|
1584
1590
|
Only card transactions can be authorized. This endpoint can't be used for ACH transactions.
|
|
1585
|
-
<Tip>
|
|
1586
|
-
Consider migrating to the [v2 Authorize endpoint](/developers/api-reference/moneyinV2/authorize-a-transaction) to take advantage of unified response codes and improved response consistency.
|
|
1587
|
-
</Tip>
|
|
1588
1591
|
</dd>
|
|
1589
1592
|
</dl>
|
|
1590
1593
|
</dd>
|
|
@@ -1682,7 +1685,7 @@ client.money_in.authorize(
|
|
|
1682
1685
|
<dd>
|
|
1683
1686
|
|
|
1684
1687
|
<Warning>
|
|
1685
|
-
This endpoint is deprecated
|
|
1688
|
+
This endpoint is deprecated. Use [POST `/capture/{transId}`](/developers/api-reference/moneyin/capture-an-authorized-transaction) instead, which supports partial captures and service fee adjustments.
|
|
1686
1689
|
</Warning>
|
|
1687
1690
|
|
|
1688
1691
|
Capture an [authorized
|
|
@@ -1759,13 +1762,13 @@ client.money_in.capture(
|
|
|
1759
1762
|
<dl>
|
|
1760
1763
|
<dd>
|
|
1761
1764
|
|
|
1765
|
+
<Warning>
|
|
1766
|
+
This endpoint is deprecated. Use it only to capture transactions originally authorized with the legacy [Authorize endpoint](/developers/api-reference/moneyin/authorize-a-transaction). New integrations should use the [Capture endpoint](/developers/api-reference/moneyinV2/capture-an-authorized-transaction), which only works on transactions authorized with the current [Authorize endpoint](/developers/api-reference/moneyinV2/authorize-a-transaction).
|
|
1767
|
+
</Warning>
|
|
1768
|
+
|
|
1762
1769
|
Capture an [authorized transaction](/developers/api-reference/moneyin/authorize-a-transaction) to complete the transaction and move funds from the customer to merchant account.
|
|
1763
1770
|
|
|
1764
1771
|
You can use this endpoint to capture both full and partial amounts of the original authorized transaction. See [Capture an authorized transaction](/developers/developer-guides/pay-in-auth-and-capture) for more information about this endpoint.
|
|
1765
|
-
|
|
1766
|
-
<Tip>
|
|
1767
|
-
Consider migrating to the [v2 Capture endpoint](/developers/api-reference/moneyinV2/capture-an-authorized-transaction) to take advantage of unified response codes and improved response consistency.
|
|
1768
|
-
</Tip>
|
|
1769
1772
|
</dd>
|
|
1770
1773
|
</dl>
|
|
1771
1774
|
</dd>
|
|
@@ -2065,11 +2068,11 @@ client.money_in.details(trans_id: "45-as456777hhhhhhhhhh77777777-324")
|
|
|
2065
2068
|
<dl>
|
|
2066
2069
|
<dd>
|
|
2067
2070
|
|
|
2068
|
-
|
|
2071
|
+
<Warning>
|
|
2072
|
+
This endpoint is deprecated. New integrations should use the [Make a transaction endpoint](/developers/api-reference/moneyinV2/make-a-transaction) and manage the resulting transaction with the corresponding void or refund endpoints. Transactions created with this legacy endpoint must be managed with the legacy lifecycle endpoints — they aren't interchangeable with the current ones.
|
|
2073
|
+
</Warning>
|
|
2069
2074
|
|
|
2070
|
-
|
|
2071
|
-
Consider migrating to the [v2 Make a transaction endpoint](/developers/api-reference/moneyinV2/make-a-transaction) to take advantage of unified response codes and improved response consistency.
|
|
2072
|
-
</Tip>
|
|
2075
|
+
Make a single transaction. This method authorizes and captures a payment in one step.
|
|
2073
2076
|
</dd>
|
|
2074
2077
|
</dl>
|
|
2075
2078
|
</dd>
|
|
@@ -2190,7 +2193,11 @@ client.money_in.getpaid(
|
|
|
2190
2193
|
<dl>
|
|
2191
2194
|
<dd>
|
|
2192
2195
|
|
|
2193
|
-
|
|
2196
|
+
<Warning>
|
|
2197
|
+
This endpoint is deprecated and only works on transactions created with the legacy endpoints. There's no equivalent in the current endpoints. For transactions created with [Make a transaction](/developers/api-reference/moneyinV2/make-a-transaction) or [Authorize](/developers/api-reference/moneyinV2/authorize-a-transaction), check the transaction's settlement status and call [Void](/developers/api-reference/moneyinV2/void-a-transaction) or [Refund](/developers/api-reference/moneyinV2/refund-a-settled-transaction) based on the result.
|
|
2198
|
+
</Warning>
|
|
2199
|
+
|
|
2200
|
+
A reversal either refunds or voids a transaction independent of the transaction's settlement status. Send a reversal request for a transaction, and Payabli automatically determines whether it's a refund or void. You don't need to know whether the transaction is settled or not. This endpoint only works on transactions made with the legacy endpoints. For transactions made with the current endpoints, check the transaction's settlement status and call void or refund based on the result.
|
|
2194
2201
|
</dd>
|
|
2195
2202
|
</dl>
|
|
2196
2203
|
</dd>
|
|
@@ -2269,11 +2276,11 @@ An amount equal to zero will refunds the total amount authorized minus any servi
|
|
|
2269
2276
|
<dl>
|
|
2270
2277
|
<dd>
|
|
2271
2278
|
|
|
2272
|
-
|
|
2279
|
+
<Warning>
|
|
2280
|
+
This endpoint is deprecated. Use it only to refund transactions originally created with the legacy endpoints. New integrations should use the [Refund endpoint](/developers/api-reference/moneyinV2/refund-a-settled-transaction), which only works on transactions created with [Make a transaction](/developers/api-reference/moneyinV2/make-a-transaction) or [Authorize](/developers/api-reference/moneyinV2/authorize-a-transaction).
|
|
2281
|
+
</Warning>
|
|
2273
2282
|
|
|
2274
|
-
|
|
2275
|
-
Consider migrating to the [v2 Refund endpoint](/developers/api-reference/moneyinV2/refund-a-settled-transaction) to take advantage of unified response codes and improved response consistency.
|
|
2276
|
-
</Tip>
|
|
2283
|
+
Refund a transaction that has settled and send money back to the account holder. If a transaction hasn't been settled, void it instead.
|
|
2277
2284
|
</dd>
|
|
2278
2285
|
</dl>
|
|
2279
2286
|
</dd>
|
|
@@ -2352,6 +2359,10 @@ An amount equal to zero will refund the total amount authorized minus any servic
|
|
|
2352
2359
|
<dl>
|
|
2353
2360
|
<dd>
|
|
2354
2361
|
|
|
2362
|
+
<Warning>
|
|
2363
|
+
This endpoint is deprecated. Use it only to refund transactions originally created with the legacy endpoints. To refund a split-funded transaction created with [Make a transaction](/developers/api-reference/moneyinV2/make-a-transaction) or [Authorize](/developers/api-reference/moneyinV2/authorize-a-transaction), use the [Refund endpoint](/developers/api-reference/moneyinV2/refund-a-settled-transaction) with split instructions in the request body.
|
|
2364
|
+
</Warning>
|
|
2365
|
+
|
|
2355
2366
|
Refunds a settled transaction with split instructions.
|
|
2356
2367
|
</dd>
|
|
2357
2368
|
</dl>
|
|
@@ -2746,11 +2757,11 @@ client.money_in.validate(
|
|
|
2746
2757
|
<dl>
|
|
2747
2758
|
<dd>
|
|
2748
2759
|
|
|
2749
|
-
|
|
2760
|
+
<Warning>
|
|
2761
|
+
This endpoint is deprecated. Use it only to void transactions originally created with the legacy endpoints. New integrations should use the [Void endpoint](/developers/api-reference/moneyinV2/void-a-transaction), which only works on transactions created with [Make a transaction](/developers/api-reference/moneyinV2/make-a-transaction) or [Authorize](/developers/api-reference/moneyinV2/authorize-a-transaction).
|
|
2762
|
+
</Warning>
|
|
2750
2763
|
|
|
2751
|
-
|
|
2752
|
-
Consider migrating to the [v2 Void endpoint](/developers/api-reference/moneyinV2/void-a-transaction) to take advantage of unified response codes and improved response consistency.
|
|
2753
|
-
</Tip>
|
|
2764
|
+
Cancel a transaction that hasn't been settled yet. Voiding non-captured authorizations prevents future captures. If a transaction has been settled, refund it instead.
|
|
2754
2765
|
</dd>
|
|
2755
2766
|
</dl>
|
|
2756
2767
|
</dd>
|
|
@@ -3088,7 +3099,7 @@ client.money_in.capturev_2(
|
|
|
3088
3099
|
</dl>
|
|
3089
3100
|
</details>
|
|
3090
3101
|
|
|
3091
|
-
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">refundv_2</a>(trans_id) -> Payabli::Types::V2TransactionResponseWrapper</code></summary>
|
|
3102
|
+
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">refundv_2</a>(trans_id, request) -> Payabli::Types::V2TransactionResponseWrapper</code></summary>
|
|
3092
3103
|
<dl>
|
|
3093
3104
|
<dd>
|
|
3094
3105
|
|
|
@@ -3100,9 +3111,13 @@ client.money_in.capturev_2(
|
|
|
3100
3111
|
<dl>
|
|
3101
3112
|
<dd>
|
|
3102
3113
|
|
|
3103
|
-
Give a full refund for a transaction that has settled and send money back to the account holder. To perform a partial refund, see [Partially refund a transaction](developers/api-reference/moneyinV2/partial-refund-a-settled-transaction).
|
|
3114
|
+
Give a full refund for a transaction that has settled and send money back to the account holder. To perform a partial refund, see [Partially refund a transaction](/developers/api-reference/moneyinV2/partial-refund-a-settled-transaction).
|
|
3104
3115
|
|
|
3105
3116
|
This is the v2 version of the refund endpoint, and returns the unified response format. See [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for more information.
|
|
3117
|
+
|
|
3118
|
+
<Note>
|
|
3119
|
+
To refund a split-funded transaction, include split instructions in the request body. Omit the body for a standard refund.
|
|
3120
|
+
</Note>
|
|
3106
3121
|
</dd>
|
|
3107
3122
|
</dl>
|
|
3108
3123
|
</dd>
|
|
@@ -3140,6 +3155,14 @@ client.money_in.refundv_2(trans_id: "10-3ffa27df-b171-44e0-b251-e95fbfc7a723")
|
|
|
3140
3155
|
<dl>
|
|
3141
3156
|
<dd>
|
|
3142
3157
|
|
|
3158
|
+
**request:** `Payabli::Types::RefundV2Request`
|
|
3159
|
+
|
|
3160
|
+
</dd>
|
|
3161
|
+
</dl>
|
|
3162
|
+
|
|
3163
|
+
<dl>
|
|
3164
|
+
<dd>
|
|
3165
|
+
|
|
3143
3166
|
**request_options:** `Payabli::MoneyIn::RequestOptions`
|
|
3144
3167
|
|
|
3145
3168
|
</dd>
|
|
@@ -3152,7 +3175,7 @@ client.money_in.refundv_2(trans_id: "10-3ffa27df-b171-44e0-b251-e95fbfc7a723")
|
|
|
3152
3175
|
</dl>
|
|
3153
3176
|
</details>
|
|
3154
3177
|
|
|
3155
|
-
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">refundv_2_amount</a>(trans_id, amount) -> Payabli::Types::V2TransactionResponseWrapper</code></summary>
|
|
3178
|
+
<details><summary><code>client.money_in.<a href="/lib/payabli/money_in/client.rb">refundv_2_amount</a>(trans_id, amount, request) -> Payabli::Types::V2TransactionResponseWrapper</code></summary>
|
|
3156
3179
|
<dl>
|
|
3157
3180
|
<dd>
|
|
3158
3181
|
|
|
@@ -3164,9 +3187,13 @@ client.money_in.refundv_2(trans_id: "10-3ffa27df-b171-44e0-b251-e95fbfc7a723")
|
|
|
3164
3187
|
<dl>
|
|
3165
3188
|
<dd>
|
|
3166
3189
|
|
|
3167
|
-
Refund a transaction that has settled and send money back to the account holder. If `amount` is
|
|
3190
|
+
Refund a transaction that has settled and send money back to the account holder. If `amount` is set to 0, performs a full refund. When a non-zero `amount` is provided, this endpoint performs a partial refund.
|
|
3168
3191
|
|
|
3169
3192
|
This is the v2 version of the refund endpoint, and returns the unified response format. See [Pay In unified response codes reference](/guides/pay-in-unified-response-codes-reference) for more information.
|
|
3193
|
+
|
|
3194
|
+
<Note>
|
|
3195
|
+
To refund a split-funded transaction, include split instructions in the request body. Omit the body for a standard refund.
|
|
3196
|
+
</Note>
|
|
3170
3197
|
</dd>
|
|
3171
3198
|
</dl>
|
|
3172
3199
|
</dd>
|
|
@@ -3207,7 +3234,15 @@ client.money_in.refundv_2_amount(
|
|
|
3207
3234
|
<dl>
|
|
3208
3235
|
<dd>
|
|
3209
3236
|
|
|
3210
|
-
**amount:** `Integer` — Amount to refund from original transaction, minus any service fees charged on the original transaction. If
|
|
3237
|
+
**amount:** `Integer` — Amount to refund from original transaction, minus any service fees charged on the original transaction. If set to 0, performs a full refund.
|
|
3238
|
+
|
|
3239
|
+
</dd>
|
|
3240
|
+
</dl>
|
|
3241
|
+
|
|
3242
|
+
<dl>
|
|
3243
|
+
<dd>
|
|
3244
|
+
|
|
3245
|
+
**request:** `Payabli::Types::RefundV2Request`
|
|
3211
3246
|
|
|
3212
3247
|
</dd>
|
|
3213
3248
|
</dl>
|
|
@@ -4734,6 +4769,8 @@ client.invoice.get_invoice_pdf(id_invoice: 23548884)
|
|
|
4734
4769
|
<dd>
|
|
4735
4770
|
|
|
4736
4771
|
Generates a payment link for an invoice from the invoice ID.
|
|
4772
|
+
|
|
4773
|
+
The payment page configuration blocks (`logo`, `page`, `paymentMethods`, `review`, `messageBeforePaying`, `paymentButton`, `notes`, `contactUs`, and `settings`) are optional. When you omit a block, Payabli applies a default rather than hiding it. The block is enabled at a fixed display order, so the generated page stays complete and branded. To hide a section, send the block explicitly with `enabled` set to `false`. An explicit value is always honored and is never replaced by a default. For each block's default, see its description in the request body.
|
|
4737
4774
|
</dd>
|
|
4738
4775
|
</dl>
|
|
4739
4776
|
</dd>
|
|
@@ -4903,7 +4940,7 @@ client.payment_link.add_pay_link_from_invoice(
|
|
|
4903
4940
|
<dl>
|
|
4904
4941
|
<dd>
|
|
4905
4942
|
|
|
4906
|
-
**contact_us:** `Payabli::Types::ContactElement` —
|
|
4943
|
+
**contact_us:** `Payabli::Types::ContactElement` — Contact us section of payment link page. If omitted, this block is enabled at display order 11.
|
|
4907
4944
|
|
|
4908
4945
|
</dd>
|
|
4909
4946
|
</dl>
|
|
@@ -4911,7 +4948,7 @@ client.payment_link.add_pay_link_from_invoice(
|
|
|
4911
4948
|
<dl>
|
|
4912
4949
|
<dd>
|
|
4913
4950
|
|
|
4914
|
-
**invoices:** `Payabli::Types::InvoiceElement` — Invoices section of payment link page
|
|
4951
|
+
**invoices:** `Payabli::Types::InvoiceElement` — Invoices section of payment link page. Required. Omitting it returns a `400` error with code `7045`.
|
|
4915
4952
|
|
|
4916
4953
|
</dd>
|
|
4917
4954
|
</dl>
|
|
@@ -4919,7 +4956,7 @@ client.payment_link.add_pay_link_from_invoice(
|
|
|
4919
4956
|
<dl>
|
|
4920
4957
|
<dd>
|
|
4921
4958
|
|
|
4922
|
-
**logo:** `Payabli::Types::Element` — Logo section of payment link page
|
|
4959
|
+
**logo:** `Payabli::Types::Element` — Logo section of payment link page. If omitted, this block is enabled at display order 1, and the logo image is resolved from the paypoint's entry logo.
|
|
4923
4960
|
|
|
4924
4961
|
</dd>
|
|
4925
4962
|
</dl>
|
|
@@ -4927,7 +4964,7 @@ client.payment_link.add_pay_link_from_invoice(
|
|
|
4927
4964
|
<dl>
|
|
4928
4965
|
<dd>
|
|
4929
4966
|
|
|
4930
|
-
**message_before_paying:** `Payabli::Types::LabelElement` — Message section of payment link page
|
|
4967
|
+
**message_before_paying:** `Payabli::Types::LabelElement` — Message section of payment link page. If omitted, this block is enabled at display order 5.
|
|
4931
4968
|
|
|
4932
4969
|
</dd>
|
|
4933
4970
|
</dl>
|
|
@@ -4935,7 +4972,7 @@ client.payment_link.add_pay_link_from_invoice(
|
|
|
4935
4972
|
<dl>
|
|
4936
4973
|
<dd>
|
|
4937
4974
|
|
|
4938
|
-
**notes:** `Payabli::Types::NoteElement` — Notes section of payment link page
|
|
4975
|
+
**notes:** `Payabli::Types::NoteElement` — Notes section of payment link page. If omitted, this block is enabled at display order 10.
|
|
4939
4976
|
|
|
4940
4977
|
</dd>
|
|
4941
4978
|
</dl>
|
|
@@ -4943,7 +4980,7 @@ client.payment_link.add_pay_link_from_invoice(
|
|
|
4943
4980
|
<dl>
|
|
4944
4981
|
<dd>
|
|
4945
4982
|
|
|
4946
|
-
**page:** `Payabli::Types::PageElement` — Page header section of payment link page
|
|
4983
|
+
**page:** `Payabli::Types::PageElement` — Page header section of payment link page. If omitted, this block is enabled at display order 2.
|
|
4947
4984
|
|
|
4948
4985
|
</dd>
|
|
4949
4986
|
</dl>
|
|
@@ -4951,7 +4988,7 @@ client.payment_link.add_pay_link_from_invoice(
|
|
|
4951
4988
|
<dl>
|
|
4952
4989
|
<dd>
|
|
4953
4990
|
|
|
4954
|
-
**payment_button:** `Payabli::Types::LabelElement` — Payment button section of payment link page
|
|
4991
|
+
**payment_button:** `Payabli::Types::LabelElement` — Payment button section of payment link page. If omitted, this block is enabled at display order 6, with the label "Pay Now".
|
|
4955
4992
|
|
|
4956
4993
|
</dd>
|
|
4957
4994
|
</dl>
|
|
@@ -4959,7 +4996,7 @@ client.payment_link.add_pay_link_from_invoice(
|
|
|
4959
4996
|
<dl>
|
|
4960
4997
|
<dd>
|
|
4961
4998
|
|
|
4962
|
-
**payment_methods:** `Payabli::Types::MethodElement` — Payment methods section of payment link page
|
|
4999
|
+
**payment_methods:** `Payabli::Types::MethodElement` — Payment methods section of payment link page. If omitted, this block is enabled at display order 3, with all payment methods enabled except RDC.
|
|
4963
5000
|
|
|
4964
5001
|
</dd>
|
|
4965
5002
|
</dl>
|
|
@@ -4975,7 +5012,7 @@ client.payment_link.add_pay_link_from_invoice(
|
|
|
4975
5012
|
<dl>
|
|
4976
5013
|
<dd>
|
|
4977
5014
|
|
|
4978
|
-
**review:** `Payabli::Types::HeaderElement` — Review section of payment link page
|
|
5015
|
+
**review:** `Payabli::Types::HeaderElement` — Review section of payment link page. If omitted, this block is enabled at display order 4.
|
|
4979
5016
|
|
|
4980
5017
|
</dd>
|
|
4981
5018
|
</dl>
|
|
@@ -4983,7 +5020,7 @@ client.payment_link.add_pay_link_from_invoice(
|
|
|
4983
5020
|
<dl>
|
|
4984
5021
|
<dd>
|
|
4985
5022
|
|
|
4986
|
-
**settings:** `Payabli::Types::PagelinkSetting` — Settings section of payment link page
|
|
5023
|
+
**settings:** `Payabli::Types::PagelinkSetting` — Settings section of payment link page. If omitted, defaults are applied, including page color `#10a0e3` and language `en`.
|
|
4987
5024
|
|
|
4988
5025
|
</dd>
|
|
4989
5026
|
</dl>
|
|
@@ -13254,6 +13291,8 @@ List of field names accepted:
|
|
|
13254
13291
|
- `paypointDbaName` (ne, eq, ct, nct)
|
|
13255
13292
|
- `batchNumber` (ne, eq, ct, nct)
|
|
13256
13293
|
- `batchId` (ne, eq, in, nin)
|
|
13294
|
+
- `detailType` (eq, ne, in, nin, ct, nct)
|
|
13295
|
+
- `detailMethod` (eq, ne, in, nin, ct, nct)
|
|
13257
13296
|
|
|
13258
13297
|
</dd>
|
|
13259
13298
|
</dl>
|
|
@@ -13381,6 +13420,8 @@ List of field names accepted:
|
|
|
13381
13420
|
- `paypointDbaName` (ne, eq, ct, nct)
|
|
13382
13421
|
- `batchNumber` (ne, eq, ct, nct)
|
|
13383
13422
|
- `batchId` (ne, eq, in, nin)
|
|
13423
|
+
- `detailType` (eq, ne, in, nin, ct, nct)
|
|
13424
|
+
- `detailMethod` (eq, ne, in, nin, ct, nct)
|
|
13384
13425
|
|
|
13385
13426
|
</dd>
|
|
13386
13427
|
</dl>
|
|
@@ -25500,7 +25541,7 @@ client.vendor.enrich_vendor(
|
|
|
25500
25541
|
<dl>
|
|
25501
25542
|
<dd>
|
|
25502
25543
|
|
|
25503
|
-
**schedule_call_if_needed:** `Internal::Types::Boolean` — When `true`,
|
|
25544
|
+
**schedule_call_if_needed:** `Internal::Types::Boolean` — When `true`, Payabli schedules an AI outreach call to the vendor if the enrichment stages return insufficient payment acceptance info. The call collects the vendor's preferred payment method and contact email. This is the third enrichment stage and is opt-in at the org level. See the schedule outreach call endpoint for behavior and requirements.
|
|
25504
25545
|
|
|
25505
25546
|
</dd>
|
|
25506
25547
|
</dl>
|
|
@@ -25540,6 +25581,203 @@ client.vendor.enrich_vendor(
|
|
|
25540
25581
|
</dl>
|
|
25541
25582
|
|
|
25542
25583
|
|
|
25584
|
+
</dd>
|
|
25585
|
+
</dl>
|
|
25586
|
+
</details>
|
|
25587
|
+
|
|
25588
|
+
<details><summary><code>client.vendor.<a href="/lib/payabli/vendor/client.rb">schedule_enrichment_call</a>(entry, request) -> Payabli::Types::VendorScheduleCallResponse</code></summary>
|
|
25589
|
+
<dl>
|
|
25590
|
+
<dd>
|
|
25591
|
+
|
|
25592
|
+
#### 📝 Description
|
|
25593
|
+
|
|
25594
|
+
<dl>
|
|
25595
|
+
<dd>
|
|
25596
|
+
|
|
25597
|
+
<dl>
|
|
25598
|
+
<dd>
|
|
25599
|
+
|
|
25600
|
+
Schedules an AI outreach call to a vendor to collect their preferred payment method and contact email. This is the third enrichment stage. Calls are scheduled for the next business day at around 9 AM in the vendor's timezone, with retries on no-answer and a fallback payment method applied when retries are exhausted. This feature is opt-in at the org level. Contact your Payabli representative to enable it, provision a phone number, and discuss pricing.
|
|
25601
|
+
</dd>
|
|
25602
|
+
</dl>
|
|
25603
|
+
</dd>
|
|
25604
|
+
</dl>
|
|
25605
|
+
|
|
25606
|
+
#### 🔌 Usage
|
|
25607
|
+
|
|
25608
|
+
<dl>
|
|
25609
|
+
<dd>
|
|
25610
|
+
|
|
25611
|
+
<dl>
|
|
25612
|
+
<dd>
|
|
25613
|
+
|
|
25614
|
+
```ruby
|
|
25615
|
+
client.vendor.schedule_enrichment_call(
|
|
25616
|
+
entry: "8cfec329267",
|
|
25617
|
+
vendor_id: 456,
|
|
25618
|
+
phone: "5555550200",
|
|
25619
|
+
enrichment_id: "enrich-3890-a1b2c3d4",
|
|
25620
|
+
bill_id: 54323,
|
|
25621
|
+
fallback_method: "check",
|
|
25622
|
+
max_retries: 3,
|
|
25623
|
+
timezone: "America/New_York"
|
|
25624
|
+
)
|
|
25625
|
+
```
|
|
25626
|
+
</dd>
|
|
25627
|
+
</dl>
|
|
25628
|
+
</dd>
|
|
25629
|
+
</dl>
|
|
25630
|
+
|
|
25631
|
+
#### ⚙️ Parameters
|
|
25632
|
+
|
|
25633
|
+
<dl>
|
|
25634
|
+
<dd>
|
|
25635
|
+
|
|
25636
|
+
<dl>
|
|
25637
|
+
<dd>
|
|
25638
|
+
|
|
25639
|
+
**entry:** `String` — Entrypoint identifier.
|
|
25640
|
+
|
|
25641
|
+
</dd>
|
|
25642
|
+
</dl>
|
|
25643
|
+
|
|
25644
|
+
<dl>
|
|
25645
|
+
<dd>
|
|
25646
|
+
|
|
25647
|
+
**vendor_id:** `Integer` — ID of the vendor to call. Must be active and belong to the entrypoint in the path.
|
|
25648
|
+
|
|
25649
|
+
</dd>
|
|
25650
|
+
</dl>
|
|
25651
|
+
|
|
25652
|
+
<dl>
|
|
25653
|
+
<dd>
|
|
25654
|
+
|
|
25655
|
+
**phone:** `String` — Vendor phone number to call, digits only. Optional. When omitted, Payabli uses the phone number on the vendor's record. If the vendor has no phone on record, the request returns an error.
|
|
25656
|
+
|
|
25657
|
+
</dd>
|
|
25658
|
+
</dl>
|
|
25659
|
+
|
|
25660
|
+
<dl>
|
|
25661
|
+
<dd>
|
|
25662
|
+
|
|
25663
|
+
**enrichment_id:** `String` — ID of the originating enrichment run to associate with this call. Optional. When omitted, Payabli generates a standalone call schedule and skips the enrichment lookup. The bill due-date check only runs when both `enrichmentId` and `billId` are supplied.
|
|
25664
|
+
|
|
25665
|
+
</dd>
|
|
25666
|
+
</dl>
|
|
25667
|
+
|
|
25668
|
+
<dl>
|
|
25669
|
+
<dd>
|
|
25670
|
+
|
|
25671
|
+
**bill_id:** `Integer` — Bill ID used for the due-date check. When the bill is due in fewer than three days, the call is skipped and the fallback method is applied. Only evaluated when `enrichmentId` is also supplied.
|
|
25672
|
+
|
|
25673
|
+
</dd>
|
|
25674
|
+
</dl>
|
|
25675
|
+
|
|
25676
|
+
<dl>
|
|
25677
|
+
<dd>
|
|
25678
|
+
|
|
25679
|
+
**fallback_method:** `String` — Payment method to apply to the vendor record if the call can't determine a preference or all retries are exhausted. Values are `check` (the default) or `managed`.
|
|
25680
|
+
|
|
25681
|
+
</dd>
|
|
25682
|
+
</dl>
|
|
25683
|
+
|
|
25684
|
+
<dl>
|
|
25685
|
+
<dd>
|
|
25686
|
+
|
|
25687
|
+
**max_retries:** `Integer` — Number of times to retry the call if the vendor doesn't answer. Defaults to 3. Maximum is 5. The get outreach call status response reports this value as `maxAttempts`.
|
|
25688
|
+
|
|
25689
|
+
</dd>
|
|
25690
|
+
</dl>
|
|
25691
|
+
|
|
25692
|
+
<dl>
|
|
25693
|
+
<dd>
|
|
25694
|
+
|
|
25695
|
+
**timezone:** `String` — IANA timezone identifier used to schedule the call in the vendor's local time. Defaults to `America/New_York`.
|
|
25696
|
+
|
|
25697
|
+
</dd>
|
|
25698
|
+
</dl>
|
|
25699
|
+
|
|
25700
|
+
<dl>
|
|
25701
|
+
<dd>
|
|
25702
|
+
|
|
25703
|
+
**send_now:** `Internal::Types::Boolean` — When `true`, dispatches the call immediately and bypasses the business-hours window and the bill due-date check. Defaults to `false`.
|
|
25704
|
+
|
|
25705
|
+
</dd>
|
|
25706
|
+
</dl>
|
|
25707
|
+
|
|
25708
|
+
<dl>
|
|
25709
|
+
<dd>
|
|
25710
|
+
|
|
25711
|
+
**request_options:** `Payabli::Vendor::RequestOptions`
|
|
25712
|
+
|
|
25713
|
+
</dd>
|
|
25714
|
+
</dl>
|
|
25715
|
+
</dd>
|
|
25716
|
+
</dl>
|
|
25717
|
+
|
|
25718
|
+
|
|
25719
|
+
</dd>
|
|
25720
|
+
</dl>
|
|
25721
|
+
</details>
|
|
25722
|
+
|
|
25723
|
+
<details><summary><code>client.vendor.<a href="/lib/payabli/vendor/client.rb">get_enrichment_call_status</a>(id_vendor) -> Payabli::Types::VendorCallStatusResponse</code></summary>
|
|
25724
|
+
<dl>
|
|
25725
|
+
<dd>
|
|
25726
|
+
|
|
25727
|
+
#### 📝 Description
|
|
25728
|
+
|
|
25729
|
+
<dl>
|
|
25730
|
+
<dd>
|
|
25731
|
+
|
|
25732
|
+
<dl>
|
|
25733
|
+
<dd>
|
|
25734
|
+
|
|
25735
|
+
Returns the latest AI outreach call activity for a vendor. The response is a composite object with a `state` discriminator (`none`, `scheduled`, `successful`, or `failed`); the block that matches the current state is populated. When the vendor has no call activity, `state` is `none` and the response returns HTTP 200.
|
|
25736
|
+
</dd>
|
|
25737
|
+
</dl>
|
|
25738
|
+
</dd>
|
|
25739
|
+
</dl>
|
|
25740
|
+
|
|
25741
|
+
#### 🔌 Usage
|
|
25742
|
+
|
|
25743
|
+
<dl>
|
|
25744
|
+
<dd>
|
|
25745
|
+
|
|
25746
|
+
<dl>
|
|
25747
|
+
<dd>
|
|
25748
|
+
|
|
25749
|
+
```ruby
|
|
25750
|
+
client.vendor.get_enrichment_call_status(id_vendor: 456)
|
|
25751
|
+
```
|
|
25752
|
+
</dd>
|
|
25753
|
+
</dl>
|
|
25754
|
+
</dd>
|
|
25755
|
+
</dl>
|
|
25756
|
+
|
|
25757
|
+
#### ⚙️ Parameters
|
|
25758
|
+
|
|
25759
|
+
<dl>
|
|
25760
|
+
<dd>
|
|
25761
|
+
|
|
25762
|
+
<dl>
|
|
25763
|
+
<dd>
|
|
25764
|
+
|
|
25765
|
+
**id_vendor:** `Integer` — ID of the vendor to read call status for.
|
|
25766
|
+
|
|
25767
|
+
</dd>
|
|
25768
|
+
</dl>
|
|
25769
|
+
|
|
25770
|
+
<dl>
|
|
25771
|
+
<dd>
|
|
25772
|
+
|
|
25773
|
+
**request_options:** `Payabli::Vendor::RequestOptions`
|
|
25774
|
+
|
|
25775
|
+
</dd>
|
|
25776
|
+
</dl>
|
|
25777
|
+
</dd>
|
|
25778
|
+
</dl>
|
|
25779
|
+
|
|
25780
|
+
|
|
25543
25781
|
</dd>
|
|
25544
25782
|
</dl>
|
|
25545
25783
|
</details>
|
|
@@ -25856,6 +26094,8 @@ Authorizes a transaction for payout.
|
|
|
25856
26094
|
If you don't pass `autoCapture` with a value of `true`, authorized transactions aren't flagged for settlement until captured. Use the `referenceId` returned in the response to capture the transaction.
|
|
25857
26095
|
|
|
25858
26096
|
When `autoCapture` is `true`, Payabli captures the transaction asynchronously after authorization. The response confirms only that the transaction was authorized; it doesn't confirm that capture succeeded. To confirm capture, listen for the [`payout_transaction_approvedcaptured`](/developers/webhooks/payout-transaction-approved-captured) webhook event.
|
|
26097
|
+
|
|
26098
|
+
If a velocity fraud alert is triggered, the endpoint returns a `202` response with `responseCode` `9051`, and the authorization is held for risk review rather than rejected. If a risk policy blocks the transaction, the endpoint returns a `422` response with `responseCode` `9005`, a terminal rejection.
|
|
25859
26099
|
</dd>
|
|
25860
26100
|
</dl>
|
|
25861
26101
|
</dd>
|
|
@@ -26310,7 +26550,9 @@ client.money_out.capture_all_out(body: %w[2-29 2-28 2-27])
|
|
|
26310
26550
|
<dl>
|
|
26311
26551
|
<dd>
|
|
26312
26552
|
|
|
26313
|
-
Captures a single authorized payout transaction by ID. If the transaction was authorized with `autoCapture` set to `true`,
|
|
26553
|
+
Captures a single authorized payout transaction by ID. If the transaction was authorized with `autoCapture` set to `true`, you don't need to call this endpoint to capture the transaction for processing.
|
|
26554
|
+
|
|
26555
|
+
If a velocity fraud alert is triggered, the endpoint returns a `202` response with `responseCode` `9051`, and the capture is held for risk review rather than rejected. If a risk policy blocks the transaction, the endpoint returns a `422` response with `responseCode` `9005`, a terminal rejection.
|
|
26314
26556
|
</dd>
|
|
26315
26557
|
</dl>
|
|
26316
26558
|
</dd>
|
|
@@ -26488,6 +26730,83 @@ client.money_out.v_card_get(card_token: "20230403315245421165")
|
|
|
26488
26730
|
</dl>
|
|
26489
26731
|
|
|
26490
26732
|
|
|
26733
|
+
</dd>
|
|
26734
|
+
</dl>
|
|
26735
|
+
</details>
|
|
26736
|
+
|
|
26737
|
+
<details><summary><code>client.money_out.<a href="/lib/payabli/money_out/client.rb">renew_v_card</a>(card_token, request) -> Payabli::Types::RenewVCardResponse</code></summary>
|
|
26738
|
+
<dl>
|
|
26739
|
+
<dd>
|
|
26740
|
+
|
|
26741
|
+
#### 📝 Description
|
|
26742
|
+
|
|
26743
|
+
<dl>
|
|
26744
|
+
<dd>
|
|
26745
|
+
|
|
26746
|
+
<dl>
|
|
26747
|
+
<dd>
|
|
26748
|
+
|
|
26749
|
+
Renews an expired or expiring virtual card by extending its expiration date to a future month.
|
|
26750
|
+
|
|
26751
|
+
The card must be a virtual card that hasn't been fully used. The new expiration date must be in `MM-YYYY` or `MM/YYYY` format and no more than 2 years and 363 days in the future. The card expires on the last day of the month you specify.
|
|
26752
|
+
|
|
26753
|
+
On success, `referenceId` holds the renewed card's token (the card processor may issue a new token). The response reuses the standard payout result object, so the payment-transaction fields it carries don't apply to renewal and always return `null`.
|
|
26754
|
+
</dd>
|
|
26755
|
+
</dl>
|
|
26756
|
+
</dd>
|
|
26757
|
+
</dl>
|
|
26758
|
+
|
|
26759
|
+
#### 🔌 Usage
|
|
26760
|
+
|
|
26761
|
+
<dl>
|
|
26762
|
+
<dd>
|
|
26763
|
+
|
|
26764
|
+
<dl>
|
|
26765
|
+
<dd>
|
|
26766
|
+
|
|
26767
|
+
```ruby
|
|
26768
|
+
client.money_out.renew_v_card(
|
|
26769
|
+
card_token: "20231206142225226104",
|
|
26770
|
+
expiration_date: "12-2027"
|
|
26771
|
+
)
|
|
26772
|
+
```
|
|
26773
|
+
</dd>
|
|
26774
|
+
</dl>
|
|
26775
|
+
</dd>
|
|
26776
|
+
</dl>
|
|
26777
|
+
|
|
26778
|
+
#### ⚙️ Parameters
|
|
26779
|
+
|
|
26780
|
+
<dl>
|
|
26781
|
+
<dd>
|
|
26782
|
+
|
|
26783
|
+
<dl>
|
|
26784
|
+
<dd>
|
|
26785
|
+
|
|
26786
|
+
**card_token:** `String` — ID for the virtual card to renew.
|
|
26787
|
+
|
|
26788
|
+
</dd>
|
|
26789
|
+
</dl>
|
|
26790
|
+
|
|
26791
|
+
<dl>
|
|
26792
|
+
<dd>
|
|
26793
|
+
|
|
26794
|
+
**expiration_date:** `String` — The new expiration date for the virtual card, in `MM-YYYY` or `MM/YYYY` format. The card expires on the last day of the month you specify. The date can't be more than 2 years and 363 days in the future.
|
|
26795
|
+
|
|
26796
|
+
</dd>
|
|
26797
|
+
</dl>
|
|
26798
|
+
|
|
26799
|
+
<dl>
|
|
26800
|
+
<dd>
|
|
26801
|
+
|
|
26802
|
+
**request_options:** `Payabli::MoneyOut::RequestOptions`
|
|
26803
|
+
|
|
26804
|
+
</dd>
|
|
26805
|
+
</dl>
|
|
26806
|
+
</dd>
|
|
26807
|
+
</dl>
|
|
26808
|
+
|
|
26809
|
+
|
|
26491
26810
|
</dd>
|
|
26492
26811
|
</dl>
|
|
26493
26812
|
</details>
|
|
@@ -26801,6 +27120,105 @@ client.money_out.reissue_out(
|
|
|
26801
27120
|
</dl>
|
|
26802
27121
|
|
|
26803
27122
|
|
|
27123
|
+
</dd>
|
|
27124
|
+
</dl>
|
|
27125
|
+
</details>
|
|
27126
|
+
|
|
27127
|
+
## Funding
|
|
27128
|
+
<details><summary><code>client.funding.<a href="/lib/payabli/funding/client.rb">deposit_funds</a>(request) -> Payabli::Types::DepositFundsResponse</code></summary>
|
|
27129
|
+
<dl>
|
|
27130
|
+
<dd>
|
|
27131
|
+
|
|
27132
|
+
#### 📝 Description
|
|
27133
|
+
|
|
27134
|
+
<dl>
|
|
27135
|
+
<dd>
|
|
27136
|
+
|
|
27137
|
+
<dl>
|
|
27138
|
+
<dd>
|
|
27139
|
+
|
|
27140
|
+
Deposits funds into a paypoint's available payout balance. Deposited funds enter a pending state and aren't available for instant payouts until confirmed through FBO reconciliation.
|
|
27141
|
+
</dd>
|
|
27142
|
+
</dl>
|
|
27143
|
+
</dd>
|
|
27144
|
+
</dl>
|
|
27145
|
+
|
|
27146
|
+
#### 🔌 Usage
|
|
27147
|
+
|
|
27148
|
+
<dl>
|
|
27149
|
+
<dd>
|
|
27150
|
+
|
|
27151
|
+
<dl>
|
|
27152
|
+
<dd>
|
|
27153
|
+
|
|
27154
|
+
```ruby
|
|
27155
|
+
client.funding.deposit_funds(
|
|
27156
|
+
amount: 10,
|
|
27157
|
+
entrypoint: "48acde49",
|
|
27158
|
+
account_id: "333"
|
|
27159
|
+
)
|
|
27160
|
+
```
|
|
27161
|
+
</dd>
|
|
27162
|
+
</dl>
|
|
27163
|
+
</dd>
|
|
27164
|
+
</dl>
|
|
27165
|
+
|
|
27166
|
+
#### ⚙️ Parameters
|
|
27167
|
+
|
|
27168
|
+
<dl>
|
|
27169
|
+
<dd>
|
|
27170
|
+
|
|
27171
|
+
<dl>
|
|
27172
|
+
<dd>
|
|
27173
|
+
|
|
27174
|
+
**amount:** `Integer` — The amount to deposit, in dollars. Must be greater than zero.
|
|
27175
|
+
|
|
27176
|
+
</dd>
|
|
27177
|
+
</dl>
|
|
27178
|
+
|
|
27179
|
+
<dl>
|
|
27180
|
+
<dd>
|
|
27181
|
+
|
|
27182
|
+
**entrypoint:** `String` — The entry point identifier for the paypoint receiving the deposit.
|
|
27183
|
+
|
|
27184
|
+
</dd>
|
|
27185
|
+
</dl>
|
|
27186
|
+
|
|
27187
|
+
<dl>
|
|
27188
|
+
<dd>
|
|
27189
|
+
|
|
27190
|
+
**account_id:** `String` — The remittance account ID to withdraw funds from.
|
|
27191
|
+
|
|
27192
|
+
</dd>
|
|
27193
|
+
</dl>
|
|
27194
|
+
|
|
27195
|
+
<dl>
|
|
27196
|
+
<dd>
|
|
27197
|
+
|
|
27198
|
+
**paypoint_id:** `Integer` — The paypoint ID. Optional if the entry point uniquely identifies the paypoint.
|
|
27199
|
+
|
|
27200
|
+
</dd>
|
|
27201
|
+
</dl>
|
|
27202
|
+
|
|
27203
|
+
<dl>
|
|
27204
|
+
<dd>
|
|
27205
|
+
|
|
27206
|
+
**same_day_ach:** `Internal::Types::Boolean` — When `true` and the request is submitted before 2 PM ET, the deposit processes as same-day ACH. If the request is submitted after 2 PM ET, it processes as standard ACH regardless of this flag.
|
|
27207
|
+
|
|
27208
|
+
</dd>
|
|
27209
|
+
</dl>
|
|
27210
|
+
|
|
27211
|
+
<dl>
|
|
27212
|
+
<dd>
|
|
27213
|
+
|
|
27214
|
+
**request_options:** `Payabli::Funding::RequestOptions`
|
|
27215
|
+
|
|
27216
|
+
</dd>
|
|
27217
|
+
</dl>
|
|
27218
|
+
</dd>
|
|
27219
|
+
</dl>
|
|
27220
|
+
|
|
27221
|
+
|
|
26804
27222
|
</dd>
|
|
26805
27223
|
</dl>
|
|
26806
27224
|
</details>
|