killbill-payeezy-plugin

Plugin to use Payeezy as a gateway.

Release builds are available on Maven Central with coordinates org.kill-bill.billing.plugin.java:payeezy-plugin.

Kill Bill compatibility

Requirements

The plugin needs a database. The latest version of the schema can be found here.

Configuration

The following properties are required:

• org.killbill.billing.plugin.payeezy.apiKey: your API Key
• org.killbill.billing.plugin.payeezy.token: your token
• org.killbill.billing.plugin.payeezy.paymentUrl: Payment service url (i.e. https://api-cert.payeezy.com or https://api.payeezy.com)

The following properties are optional:

• org.killbill.billing.plugin.payeezy.paymentConnectionTimeout: Connection time-out in milliseconds
• org.killbill.billing.plugin.payeezy.paymentReadTimeout: Read time-out in milliseconds
• org.killbill.billing.plugin.payeezy.proxyServer: Proxy server address
• org.killbill.billing.plugin.payeezy.proxyPort: Proxy server port
• org.killbill.billing.plugin.payeezy.proxyType: Proxy server type (HTTP or SOCKS)
• org.killbill.billing.plugin.payeezy.trustAllCertificates: Whether to disable SSL certificates validation

These properties can be specified globally via System Properties or on a per tenant basis:

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.payeezy.paymentUrl=WWW
org.killbill.billing.plugin.payeezy.apiKey=XXX
org.killbill.billing.plugin.payeezy.token=YYY' \
     http://127.0.0.1:8080/1.0/kb/tenants/uploadPluginConfig/killbill-payeezy

Usage

Credit cards

Add a payment method:

curl -v \
     -u admin:password \
     -H "X-Killbill-ApiKey: bob" \
     -H "X-Killbill-ApiSecret: lazar" \
     -H "Content-Type: application/json" \
     -H "X-Killbill-CreatedBy: demo" \
     -X POST \
     --data-binary '{
       "pluginName": "killbill-payeezy",
       "pluginInfo": {
         "properties": [
           {
             "key": "ccFirstName",
             "value": "John"
           },
           {
             "key": "ccLastName",
             "value": "Smith"
           },
           {
             "key": "ccExpirationMonth",
             "value": 10
           },
           {
             "key": "ccExpirationYear",
             "value": 2020
           },
           {
             "key": "ccNumber",
             "value": 4788250000028291
           },
           {
             "key": "ccType",
             "value": "visa"
           },
           {
             "key": "ccVerificationValue",
             "value": 123
           }
         ]
       }
     }' \
     "http://127.0.0.1:8080/1.0/kb/accounts/<ACCOUNT_ID>/paymentMethods?isDefault=true"

Notes:

• Make sure to replace ACCOUNT_ID with the id of the Kill Bill account
• Test data is available here

To trigger a payment:

curl -v \
     -u admin:password \
     -H "X-Killbill-ApiKey: bob" \
     -H "X-Killbill-ApiSecret: lazar" \
     -H "Content-Type: application/json" \
     -H "X-Killbill-CreatedBy: demo" \
     -X POST \
     --data-binary '{"transactionType":"AUTHORIZE","amount":"5","currency":"USD"}' \
    "http://127.0.0.1:8080/1.0/kb/accounts/<ACCOUNT_ID>/payments

Notes:

• Make sure to replace ACCOUNT_ID with the id of the Kill Bill account

You can verify the state of the transaction by listing the payments:

curl -v \
     -u admin:password \
     -H "X-Killbill-ApiKey: bob" \
     -H "X-Killbill-ApiSecret: lazar" \
     -H "Content-Type: application/json" \
     -H "X-Killbill-CreatedBy: demo" \
    "http://127.0.0.1:8080/1.0/kb/accounts/<ACCOUNT_ID>/payments?withPluginInfo=true"

Plugin properties