killbill-forte-plugin

Plugin to use Forte as a gateway.

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

Kill Bill compatibility

Plugin version	Kill Bill version
0.1.y	0.14.z
0.2.y	0.16.z
0.3.y	0.18.z

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.forte.merchantId: your merchant id
• org.killbill.billing.plugin.forte.password: your password
• org.killbill.billing.plugin.forte.host: AGI host (e.g. www.paymentsgateway.net)
• org.killbill.billing.plugin.forte.port: AGI port (e.g. 6050)
• org.killbill.billing.plugin.forte.apiLoginId: your API login id
• org.killbill.billing.plugin.forte.secureTransactionKey: your transaction key
• org.killbill.billing.plugin.forte.test: true to use the sandbox

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.forte.merchantId=AAA
org.killbill.billing.plugin.forte.password=BBB
org.killbill.billing.plugin.forte.host=CCC
org.killbill.billing.plugin.forte.port=DDD
org.killbill.billing.plugin.forte.apiLoginId=EEE
org.killbill.billing.plugin.forte.secureTransactionKey=FFF
org.killbill.billing.plugin.forte.test=true' \
     http://127.0.0.1:8080/1.0/kb/tenants/uploadPluginConfig/killbill-forte

Usage

Add a payment method (Bank Of America checking account):

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-forte",
       "pluginInfo": {
         "properties": [
           {
             "key": "accountHolderName",
             "value": "Bob Smith"
           },
           {
             "key": "trn",
             "value": "122400724"
           },
           {
             "key": "accountNumber",
             "value": "123456789"
           },
           {
             "key": "accountType",
             "value": "C"
           }
         ]
       }
     }' \
     "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

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":"PURCHASE","amount":"500","currency":"USD","transactionExternalKey":"INV-'$(uuidgen)'-PURCHASE"}' \
    "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 payment via:

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

Notes:

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