https://github.com/killbill/killbill-deposit-plugin
Batch deposit plugin for Kill Bill
https://github.com/killbill/killbill-deposit-plugin
billing killbill payment subscriptions
Last synced: about 1 year ago
JSON representation
Batch deposit plugin for Kill Bill
- Host: GitHub
- URL: https://github.com/killbill/killbill-deposit-plugin
- Owner: killbill
- License: apache-2.0
- Created: 2021-03-10T14:59:15.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-02-13T19:06:51.000Z (over 3 years ago)
- Last Synced: 2024-05-01T09:46:23.994Z (about 2 years ago)
- Topics: billing, killbill, payment, subscriptions
- Language: Java
- Homepage: https://killbill.io
- Size: 82 KB
- Stars: 1
- Watchers: 5
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# killbill-deposit-plugin
Kill Bill Deposit plugin.
## Kill Bill compatibility
| Plugin version | Kill Bill version |
|---------------:|------------------:|
| 0.y.z | 0.22.z |
| 0.1.z | 0.24.z |
## Requirements
The plugin needs a database. The latest version of the schema can be found [here](https://github.com/killbill/killbill-deposit-plugin/blob/master/src/main/resources/ddl.sql).
## Installation
Locally:
```
kpm install_java_plugin deposit --from-source-file target/deposit-*-SNAPSHOT.jar --destination /var/tmp/bundles
```
## Configuration
Configure minimum payment amounts in the plugin:
```
curl -v \
-X POST \
-u admin:password \
-H 'X-Killbill-ApiKey: bob' \
-H 'X-Killbill-ApiSecret: lazar' \
-H 'X-Killbill-CreatedBy: admin' \
-H 'Content-Type: text/plain' \
-d '!!org.killbill.billing.plugin.deposit.DepositConfiguration
minAmounts:
USD: 0.5' \
http://127.0.0.1:8080/1.0/kb/tenants/uploadPluginConfig/killbill-deposit
```
Make sure to enable the control plugin in Kill Bill:
```
org.killbill.payment.invoice.plugin=killbill-deposit
```
This can also be configured on a per-tenant or even per-request basis.
## Usage
```bash
curl -v \
-X POST \
-u admin:password \
-H "X-Killbill-ApiKey: bob" \
-H "X-Killbill-ApiSecret: lazar" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "X-Killbill-CreatedBy: testing" \
-d '{
"accountId": "e4ab98c2-3a4c-4595-ac14-b70e7324b1b5",
"effectiveDate": "2021-03-16",
"paymentReferenceNumber": "WIRE-12345",
"depositType": "wire",
"payments": [
{
"invoiceNumber": 824,
"paymentAmount": 1.23
}
]
}' \
"http://127.0.0.1:8080/plugins/killbill-deposit/record"
```
## About
Kill Bill is the leading Open-Source Subscription Billing & Payments Platform. For more information about the project, go to https://killbill.io/.