.md

CoinPayments v3

Coinpayment Laravel Package

CoinPayment is a Laravel package for handling transactions from CoinPayment like a create transaction, history transaction, etc.

Version support

version	laravel
v1.1.3	5.6
v2.0.0	5.8
v2.0.3	^6.x
Current Version	^8.x

Installation

You can install this package via composer:

$ composer require hexters/coinpayment

Publishing vendor

$ php artisan vendor:publish --tag=coinpayment

Install CoinPayment configuration

$ php artisan coinpayment:install

Installation finish.

Getting Started

Create Button transaction. Example placed on your controller

  use Hexters\CoinPayment\CoinPayment;
  . . . 
  /*
  *   @required true
  */
  $transaction['order_id'] = uniqid(); // invoice number
  $transaction['amountTotal'] = (FLOAT) 37.5;
  $transaction['note'] = 'Transaction note';
  $transaction['buyer_name'] = 'Jhone Due';
  $transaction['buyer_email'] = '[email protected]';
  $transaction['redirect_url'] = url('/back_to_tarnsaction'); // When Transaction was comleted
  $transaction['cancel_url'] = url('/back_to_tarnsaction'); // When user click cancel link


  /*
  *   @required true
  *   @example first item
  */
  $transaction['items'][] = [
    'itemDescription' => 'Product one',
    'itemPrice' => (FLOAT) 7.5, // USD
    'itemQty' => (INT) 1,
    'itemSubtotalAmount' => (FLOAT) 7.5 // USD
  ];

  /*
  *   @example second item
  */
  $transaction['items'][] = [
    'itemDescription' => 'Product two',
    'itemPrice' => (FLOAT) 10, // USD
    'itemQty' => (INT) 1,
    'itemSubtotalAmount' => (FLOAT) 10 // USD
  ];

  /*
  *   @example third item
  */
  $transaction['items'][] = [
    'itemDescription' => 'Product Three',
    'itemPrice' => (FLOAT) 10, // USD
    'itemQty' => (INT) 2,
    'itemSubtotalAmount' => (FLOAT) 20 // USD
  ];

  $transaction['payload'] = [
    'foo' => [
        'bar' => 'baz'
    ]
  ];

  return CoinPayment::generatelink($transaction);
  . . . 

Listening status transaction

Open the Job file App\Jobs\CoinpaymentListener for the listen the our transaction and proccess

Manual check without IPN

This function will execute orders without having to wait for the process from IPN

We can also make cron to run this function if we don't use IPN

use Hexters\CoinPayment\CoinPayment;

. . .

/**
* this is triger function for running Job proccess
*/
return CoinPayment::getstatusbytxnid("CPDA4VUGSBHYLXXXXXXXXXXXXXXX");
// output example: "celled / Timed Out"

Get histories transaction Eloquent

use Hexters\CoinPayment\CoinPayment;

. . .

CoinPayment::gettransactions()->where('status', 0)->get();

IPN Route

Except this path /coinpayment/ipn into csrf proccess in App\Http\Middleware\VerifyCsrfToken

. . .
/**
  * The URIs that should be excluded from CSRF verification.
  *
  * @var array
  */
protected $except = [
    '/coinpayment/ipn'
]; 
. . .

Troubleshooting

Cannot use object of type Illuminate\Http\JsonResponse as array

Visit the CoinPayment API Keys page, under Actions, click on the Edit Permissions button. Enter the IP address of your API endpoint (e.g. your website server) in the Restrict to IP/IP Range input. Leaving it empty, may cause this error to occur.

Donate

If this Laravel package was useful to you, please consider donating some coffee ☕☕☕☕

Bitcoin (BTC): 1388MHjeHmq6kUC7WpSS6pPtgG7hm7fCau