https://github.com/killbill/killbill-payment-retries-plugin
Kill Bill Payment Control plugin to control retries
https://github.com/killbill/killbill-payment-retries-plugin
Last synced: 7 months ago
JSON representation
Kill Bill Payment Control plugin to control retries
- Host: GitHub
- URL: https://github.com/killbill/killbill-payment-retries-plugin
- Owner: killbill
- License: apache-2.0
- Created: 2016-08-08T17:33:24.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2018-02-09T15:36:21.000Z (over 8 years ago)
- Last Synced: 2025-04-12T13:49:57.410Z (about 1 year ago)
- Language: Java
- Homepage: http://killbill.io
- Size: 69.3 KB
- Stars: 3
- Watchers: 4
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
killbill-payment-retries-plugin
===============================
Kill Bill Payment Control plugin to control payment retries.
Release builds are available on [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.kill-bill.billing.plugin.java%22%20AND%20a%3A%22payment-retries-plugin%22) with coordinates `org.kill-bill.billing.plugin.java:payment-retries-plugin`.
Kill Bill compatibility
-----------------------
| Plugin version | Kill Bill version |
| -------------: | ----------------: |
| 0.0.y | 0.16.z |
| 0.2.y | 0.18.z |
Usage
-----
### Private endpoints
Verify the status of a payment method associated with a failed payment:
```
curl -v \
-u admin:password \
-H "X-Killbill-ApiKey: bob" \
-H "X-Killbill-ApiSecret: lazar" \
"http://127.0.0.1:8080/plugins/payment-retries-plugin/paymentMethodCheck?paymentExternalKey=XXX"
```
List current configuration:
```
curl -v \
-u admin:password \
-H "X-Killbill-ApiKey: bob" \
-H "X-Killbill-ApiSecret: lazar" \
"http://127.0.0.1:8080/plugins/payment-retries-plugin/configuration"
```
Filter for retryable errors only:
```
curl -v \
-u admin:password \
-H "X-Killbill-ApiKey: bob" \
-H "X-Killbill-ApiSecret: lazar" \
"http://127.0.0.1:8080/plugins/payment-retries-plugin/configuration?retryable=true"
```
Filter for insufficient funds errors only (see [ErrorMessage](https://github.com/killbill/killbill-payment-retries-plugin/blob/master/src/main/java/org/killbill/billing/plugin/payment/retries/rules/ErrorMessage.java)):
```
curl -v \
-u admin:password \
-H "X-Killbill-ApiKey: bob" \
-H "X-Killbill-ApiSecret: lazar" \
"http://127.0.0.1:8080/plugins/payment-retries-plugin/configuration?errorMessage=INSUFFICIENT_FUNDS"
```