Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/plugandpay/tbc-credit-card-payment-gateway-php-lib

PHP library for the TBC credit card payment gateway API.
https://github.com/plugandpay/tbc-credit-card-payment-gateway-php-lib

credit-card payment-gateway tbc

Last synced: about 2 months ago
JSON representation

PHP library for the TBC credit card payment gateway API.

Awesome Lists containing this project

README

        

![face_post_tbc_payment](https://cloud.githubusercontent.com/assets/8479569/7435079/5aebe7cc-f051-11e4-8ee1-d85b0e36a8a9.jpg)

# TBC Credit Card Payment Gateway (php-library)

Making credit card payments work on your website (through a local bank) is pain! So to make everyone's life a bit easier we are sharing this php-library on GitHub.

### SMS / DMS

There are two types of transaction within this system: **SMS** and **DMS**.

SMS - is a direct payment method, money is charged in 1 event, as soon as customer enters the credit card details and clicks proceed.
DMS - is a two step method, first event blocks the money on the card (max 30 days), second event captures the money (second event can be carried out when product is shipped to the customer for example).

Every 24 hours, a merchant must close the business day.

### Install

It is possible to simply include this library [see example](https://github.com/wearede/tbcpay-php/tree/master/example), but you should use composer instead.

run in terminal:

```
composer require wearede/tbcpay-php
```

### Creating object

```php
$Payment = new TbcPayProcessor('/cert/tbcpay.pem', '0DhJ4AdxVuPZmz3F4y', $_SERVER['REMOTE_ADDR']);
```
1. Certificate absolute path
2. Certificate passphrase
3. Client ip address

### Methods

Method name
--- |
**sms_start_transaction()**
**dms_start_authorization()**
**dms_make_transaction($trans_id)**
**get_transaction_result($trans_id)**
**reverse_transaction($trans_id, $amount = '', $suspected_fraud = '')**
**refund_transaction($trans_id)**
**credit_transaction($trans_id, $amount = '')**
**close_day()**

### Example implementations

- To get started quickly have a look at the [fully functional working prototype](https://github.com/wearede/tbcpay-php-example).
- You can find a [simple example here](https://github.com/wearede/tbcpay-php/tree/master/example).

### Instructions

Relevant to a [simple example here](https://github.com/wearede/tbcpay-php/tree/master/example).

#### Chores
1. Ask TBC to generate a certificate.
2. Tell TBC your server IP so they can whitelist it.
3. create `example.com/ok.php` and `example.com/fail.php` urls and communicate these to TBC.
* ok url - is used for redirecting back user in almost all situations (even when card has insuficient funds and transaction fails!).
* fail url - is used for redirecting back user when technical error occurs (very rare).

#### Flow
1. `start.example` Here we start our process. We call TBC servers using `sms_start_transaction()` and get `$trans_id` in return.
* We use returned $trans_id to redirect user to a TBC page, where credit card info can be entered.
* After user fills out card info he is thrown back to our `ok.example` url on our server.
2. Take a look at `ok.example` We get `$trans_id` back from TBC, and we plug that in `get_transaction_result($trans_id)`.
3. `get_transaction_result($trans_id)` tells us if transaction was success or not. `array('RESULT' => 'OK')` for example is success message, transaction went through.

### Common issues

- TBC bank provides SSL certificate in **.p12** format, we need it in .pem format, to transform use command: `openssl pkcs12 -in *.p12 -out tbcpay.pem`.
- Move cert directory somewhere non public as a security meassure. Give it correct permissions so that php can read it.
- SDK needs outgoing port 18443 open to communicate with TBC. Some hosting services do not allow this.