jalallinux / multi-coinremitter-laravel
非官方的 Laravel 多币种支付网关插件
0.1.9
2022-05-20 08:31 UTC
Requires
- laravel/framework: >=7.0
README
laravel 的 multi-coinremitter 插件
安装指南。
您可以使用 composer 在 Laravel 中安装 coin remitter 插件。
composer require jalallinux/multi-coinremitter-laravel
库的使用
您需要在想使用此库的地方包含包的命名空间,例如:
use JalalLinuX\Coinremitter;
使用命名空间后,您可以通过创建类的对象来访问库的所有方法,例如:
$btc_wallet = new Coinremitter('BTC', [
'api_key' => 'YOUR_BTC_API_KEY',
'password' => 'YOUR_BTC_PASSWORD'
]);
这里的 "BTC" 必须在 config/coinremitter.php 文件中的数组中。
获取余额
您可以使用 get_balance 调用来获取您的钱包余额。
$balance = $btc_wallet->get_balance();
如果操作成功,将返回成功响应;如果发生错误,将返回错误响应。以下是一个成功响应示例:
{
"flag":1,
"msg":"Get balance successfully !",
"action":"get-balance",
"data":{
"balance":123
}
}
创建新钱包地址
您可以使用以下方法获取新的钱包地址
$address = $btc_wallet->get_new_address();
成功响应
{
"flag":1,
"msg":"New address created successfully !",
"action":"get-new-address",
"data":{
"address":"MMtU5BzKcrew9BdTzru9QyT3YravQmzokh",
"label":""
}
}
您还可以通过传递参数给 get_new_address 方法为您的地址分配标签,例如:
$param = [
'label'=>'my_label'
];
$address = $btc_wallet->get_new_address($param);
响应将在 label 键中添加给定的标签。
{
"flag":1,
"msg":"New address created successfully !",
"action":"get-new-address",
"data":{
"address":"MMtU5BzKcrew9BdTzru9QyT3YravQmzokh",
"label":"my_label"
}
}
验证钱包地址
使用以下方法验证钱包地址
$param = [
'address'=>'your_Address_to_validate'
];
$validate = $btc_wallet->validate_address($param);
响应
{
"flag":1,
"msg":"success",
"action":"validate-address",
"data":{
"valid":true
}
}
提款金额
要向特定地址提款金额,将使用以下方法
$param = [
'to_address'=>'YOUR_ADDRESS',
'amount'=>123
];
$withdraw = $btc_wallet->withdraw($param);
成功响应
{
"flag":1,
"msg":"Amount Successfully Withdraw !",
"action":"withdraw",
"data":{
"id":"5b5ff10a8ebb830edb4e2a22",
"txid":"1147aca98ced7684907bd469e80cdf7482fe740a1aaf75c1e55f7a60f725ba28",
"explorer_url":"http://btc.com/exp/1147aca98ced7684907bd469e80cdf7482fe740a1aaf75c1e55f7a60f725ba28",
"amount":0.1,
"transaction_fees":0.001,
"processing_fees":0.00023,
"total_amount":0.10123,
"to_address":"YOUR_ADDRESS",
"wallet_id":"5c42ea0ab846fe751421cfb2",
"wallet_name":"wallet_name",
"coin_short_name":"BTC",
"date":"2019-06-02 01:02:03"
}
}
获取交易
使用以下方法通过从 withdraw amount
响应的 id
或从 webhook 的 id
字段获取的 id 来获取交易详情
$param = [
'id'=>'5b5ff10a8ebb830edb4e2a22'
];
$transaction = $btc_wallet->get_transaction($param);
成功响应
{
"flag":1,
"msg":"success",
"action":"get-transaction",
"data":{
"id":"5b5ff10a8ebb830edb4e2a22",
"txid":"1147aca98ced7684907bd469e80cdf7482fe740a1aaf75c1e55f7a60f725ba28",
"explorer_url":"http://btc.com/exp/1147aca98ced7684907bd469e80cdf7482fe740a1aaf75c1e55f7a60f725ba28",
"type":"receive",
"merchant_id":"5bc46fb28ebb8363d2657347",
"coin_short_name":"BTC",
"wallet_id":"5c42ea0ab846fe751421cfb2",
"wallet_name":"wallet_name",
"address":"QYTZkkKz7n1sMuphtxSPdau6BQthZfpnZC",
"amount":0.0003,
"confirmations":3,
"date":"2018-08-15 15:10:42"
}
}
如果响应数据对象中包含的 type
等于 send
,则响应如下所示
{
"flag":1,
"msg":"success",
"action":"get-transaction",
"data":{
"id":"5b5ff10a8ebb830edb4e2a22",
"txid":"1147aca98ced7684907bd469e80cdf7482fe740a1aaf75c1e55f7a60f725ba28",
"explorer_url":"http://btc.com/exp/1147aca98ced7684907bd469e80cdf7482fe740a1aaf75c1e55f7a60f725ba28",
"type":"send",
"merchant_id":"5bc46fb28ebb8363d2657347",
"coin_short_name":"BTC",
"wallet_id":"5c42ea0ab846fe751421cfb2",
"wallet_name":"wallet_name",
"address":"QYTZkkKz7n1sMuphtxSPdau6BQthZfpnZC",
"amount":0.0003,
"confirmations":3,
"date":"2018-08-15 15:10:42"
"transaction_fees":0.001,
"processing_fees":0.1,
"total_amount":"2.10100000"
}
}
创建发票
您可以使用以下方法创建发票
$param = [
'amount'=>800, //required.
'notify_url'=>'https://yourdomain.com/notify-url', //optional,url on which you wants to receive notification,
'fail_url' => 'https://yourdomain.com/fail-url', //optional,url on which user will be redirect if user cancel invoice,
'suceess_url' => 'https://yourdomain.com/success-url', //optional,url on which user will be redirect when invoice paid,
'name'=>'random name',//optional,
'currency'=>'usd',//optional,
'expire_time'=>'20',//optional, invoice will expire in 20 minutes.
'description'=>'',//optional.
];
$invoice = $btc_wallet->create_invoice($param);
成功响应
{
"flag":1,
"msg":"Invoice successfully created !!!",
"action":"create-invoice",
"data":{
"id":"5b7650458ebb8306365624a2",
"invoice_id":"BTC02",
"merchant_id":"5bc46fb28ebb8363d2657347",
"url":"https://coinremitter.com/invoice/5b7650458ebb8306365624a2",
"total_amount":0.1,
"paid_amount":0,
"usd_amount":800,
"coin":"BTC",
"name":"random name",
"description":"",
"wallet_name":"wallet_name",
"address":"rger54654fgsd4h6u7dgsg",
"status":"Pending",
"status_code":0,
"notify_url":"http://yourdomain.com/notify-url",
"suceess_url":"http://yourdomain.com/success-url",
"fail_url":"http://yourdomain.com/fail-url",
"expire_on":"2018-12-06 10:35:57",
"invoice_date":"2019-12-04 18:19:10",
"last_updated_date":"2019-12-04 18:19:10"
}
}
获取发票
使用以下方法通过 invoice_id 获取发票详情
$param = [
'invoice_id'=>'ETH002'
];
$invoice = $btc_wallet->get_invoice($param);
成功响应
{
"flag":1,
"msg":"success",
"action":"get-invoice",
"data":{
"id":"5b7650458ebb8306365624a2",
"invoice_id":"BTC02",
"merchant_id":"5bc46fb28ebb8363d2657347",
"url":"http://192.168.0.112/coinremitter/public/invoice/5b7650458ebb8306365624a2",
"total_amount":0.0009,
"paid_amount":0,
"usd_amount":800,
"coin":"ETH",
"name":"random name",
"description":"Hello world",
"wallet_name":"New Test-LTC",
"address":"rger54654fgsd4h6u7dgsg",
"payment_history":[
{
"txid":"c4b853d4be7586798870a4aa766e3bb781eddb24aaafd81da8f66263017b872d",
"explorer_url":"http://btc.com/exp/c4b853d4be7586798870a4aa766e3bb781eddb24aaafd81da8f66263017b872d",
"amount":0.005,
"date":"2019-12-02 12:09:02",
"confirmation":781
},
{
"txid":"a2541253ab72d7cf29f2f9becb1e31320dd0ed418f761ab1973dc9e412a51c7f",
"explorer_url":"http://btc.com/exp/a2541253ab72d7cf29f2f9becb1e31320dd0ed418f761ab1973dc9e412a51c7f",
"amount":0.005,
"date":"2019-12-02 12:15:02",
"confirmation":778
}
],
"status":"Pending",
"status_code":0,
"suceess_url":"http://yourdomain.com/success-url",
"fail_url":"http://yourdomain.com/fail-url",
"expire_on":"2018-12-06 10:35:57",
"invoice_date":"2018-08-17 10:04:13",
"last_updated_date":"2018-08-17 10:04:13"
}
}
获取美元实时币价
使用以下方法获取币价
$rate = $btc_wallet->get_coin_rate();
成功响应
{
"flag":1,
"msg":"success",
"action":"get-coin-rate",
"data":{
"BTC":{
"symbol":"BTC",
"name":"Bitcoin",
"price":7289.01
},
"LTC":{
"symbol":"LTC",
"name":"Litecoin",
"price":145.51
},
"DOGE":{
"symbol":"DOGE",
"name":"DogeCoin",
"price":0.0001
}
}
}
获取加密货币汇率
使用以下方法获取加密货币汇率
$param = [
'fiat_symbol' => 'USD',
'fiat_amount' => 1
];
$invoice = $btc_wallet->get_fiat_to_crypto_rate($param);
成功响应
{
"flag":1,
"msg":"success",
"action":"get-fiat-to-crypto-rate",
"data":{
"crypto_amount":"0.02123593",
"crypto_symbol":"BTC",
"crypto_currency":"Bitcoin",
"fiat_amount":"1",
"fiat_symbol":"USD"
}
}
通过地址获取交易
使用以下方法通过地址获取交易
$param = [
'address' => 'MLjDMFsob8gk9EX6tj8KUKSpmHM6qG2qFK',
];
$invoice = $btc_wallet->get_transaction_by_address($param);
成功响应
{
"flag":1,
"msg":"success",
"action":"get-transaction-by-address",
"data":[
{
"id":"5b7650458ebb8306365624a2",
"txid":"7a6ca109c7c651f9b70a7d4dc8fa77de322e420119c5d2470bce7f08ba0cd1d6",
"explorer_url":"http://coin-explorer-url/exp/7a6ca109c7c651f9b70a7d4dc8fa7...",
"merchant_id":"5bc46fb28ebb8363d2657347",
"type":"receive",
"coin_short_name":"BTC",
"wallet_id":"5c42ea0ab846fe751421cfb2",
"wallet_name":"my-wallet",
"address":"MLjDMFsob8gk9EX6tj8KUKSpmHM6qG2qFK",
"amount":"2",
"confirmations":3,
"date":"2018-08-17 10:04:13"
},
{
"id":"23sdew232158ebb8306365624a2",
"txid":"7a6ca109c7c651f9b70fdgfg44er34re7de322e420119c5d2470bce7f08ba0cd1d6",
"explorer_url":"http://coin-explorer-url/exp/2322ereer344c7c651f9b70a7d4dc8fa7...",
"merchant_id":"3434df4w28ebb8363d2657347",
"type":"receive",
"coin_short_name":"BTC",
"wallet_id":"5c42ea0ab846fe751421cfb2",
"wallet_name":"my-wallet",
"address":"MLjDMFsob8gk9EX6tj8KUKSpmHM6qG2qFK",
"amount":"1",
"confirmations":2,
"date":"2018-08-17 10:05:13"
}
]
}
有关更多信息,请访问我们的 API 文档