gjorgic/my-promisepay-php

该软件包最新版本(dev-master)没有可用的许可信息。

PromisePay API的PHP SDK

dev-master 2015-08-06 10:53 UTC

This package is not auto-updated.

Last update: 2024-10-02 10:24:47 UTC


README

#PHP SDK - PromisePay API

Join the chat at https://gitter.im/PromisePay/promisepay-php

Build Status Latest Stable Version Total Downloads Code Climate

#1. 安装

###Composer

您可以通过Composer包含此软件包。

{
  "require": {
    "promisepay/promisepay-php": "1.*"
  }
}

安装软件包。

composer install

需求软件包。

require init.php

###手动安装

require init.php

#2. 配置

记录您的API令牌后,配置PHP软件包 - 请参阅以下内容。

打开文件libs/promisepay-credentials.xml,并用以下内容替换现有凭证

	<?xml version='1.0'?>
		<ApiCredentials>
   			<ApiUrl>https://test.api.promisepay.com/</ApiUrl>
   			<ApiLogin>user.name@yourdomain.com</ApiLogin>
   			<ApiPassword>Password</ApiPassword>
   			<ApiKey>APIToken</ApiKey>
	</ApiCredentials>

#3. 示例

示例1 - 请求会话令牌

以下示例展示了为自动生成项和用户ID配置的市场请求。

$repo = new TokenRepository();
$sessionToken = new Token($arr = array(
			   'current_user' 			=> 'seller',
           	   'item_name'				=> 'Test Item',
          		   'amount'					=> '2500',
           	   'seller_lastname' 		=> 'Seller',
           	   'seller_firstname'		=> 'Sally',
           	   'buyer_lastname'			=> 'Buyer',
           	   'buyer_firstname'		=> 'Bobby',
           	   'buyer_country'			=> 'AUS',
           	   'seller_country'			=> 'USA',
           	   'seller_email'			=> 'sally.seller@promisepay.com',
           	   'buyer_email'			=> 'bobby.buyer@promisepay.com',
           	   'fee_ids'				=> '',
           	   'payment_type_id'		=> '2'))
$repo->requestSessionToken($sessionToken)

#####示例2 - 请求会话令牌 以下示例展示了传递项和用户ID的市场请求。

$repo = new TokenRepository();
$sessionToken = new Token($arr = array(
			   'current_user_id' 		=> 'seller1234',
           	   'item_name'				=> 'Test Item',
          		   'amount'					=> '2500',
           	   'seller_lastname' 		=> 'Seller',
           	   'seller_firstname'		=> 'Sally',
           	   'buyer_lastname'			=> 'Buyer',
           	   'buyer_firstname'		=> 'Bobby',
           	   'buyer_country'			=> 'AUS',
           	   'seller_country'			=> 'USA',
           	   'seller_email'			=> 'sally.seller@promisepay.com',
           	   'buyer_email'			=> 'bobby.buyer@promisepay.com',
           	   'external_item_id'		=> 'TestItemId1234',
           	   'external_seller_id'		=> 'seller1234',
           	   'external_buyer_id'		=> 'buyer1234',
           	   'fee_ids'				=> '',
           	   'payment_type_id'		=> '2'))
$repo->requestSessionToken($sessionToken)

##项

#####创建项

$repo = new ItemRepository();
$user = new Item($arr = array(
           'id'            => 'External_id',
           'name'          => 'Item Name',
           'amount'        => '2000',
           'payment_type'  => '1',
           'buyer_id'      => 'External_buyer_id',
           'seller_id'     => 'External_seller_id',
           'fee_ids'       => 'fee_id_1,fee_id_2',
           'description'   => 'Item Description'));
$repo->createItem($user)

#####获取项

$repo = new ItemRepository();
$item = $repo->getItemById('item_id');

#####获取项列表

$repo = new ItemRepository();
$listOfItems = $repo->getListOfItems;

#####更新项

$repo = new ItemRepository();
$item = new Item($arr = array(
           'id'            => 'External_id',
           'name'          => 'Item Name',
           'amount'        => '2000',
           'payment_type'  => '1',
           'buyer_id'      => 'External_buyer_id',
           'seller_id'     => 'External_seller_id',
           'fee_ids'       => 'fee_id_1,fee_id_2',
           'description'   => 'Item Description'));
$repo->updateItem($item, 'user', 'account', 'release_amount');

#####删除项

$repo = new ItemRepository();
$repo->deleteItem('item_id');

#####获取项状态

$repo = new ItemRepository();
$repo->getItemStatus('item_id');

#####获取项的买家

$repo = new ItemRepository();
$buyer = $repo->getBuyerOfItem('item_id');

#####获取项的卖家

$repo = new ItemRepository();
$seller = $repo->getSellerForItem('item_id');

#####获取项的费用

$repo = new ItemRepository();
$fees = $repo->getListFeesForItems('item_id');

#####获取项的交易

$repo = new ItemRepository();
$transactions = $repo->getListOfTransactionsForItem('item_id');

#####获取项的汇款详情

$repo = new ItemRepository();
$wireDetails = $repo->getWireDetailsForItem('item_id');

#####获取项的BPAY详情

$repo = new ItemRepository();
$bpayDetails = $repo->getBPayDetailsForItem('item_id');

##用户

#####创建用户

$repo = new UserRepository();
$user = new User($arr = array(
           'id'            => id,
           'first_name'    => 'First Name',
           'last_name'     => 'Last Name',
           'email'         => 'email'
           'mobile'        => 'mobile phone'
           'address_line1' => 'a line 1',
           'address_line2' => 'a line 2',
           'state'         => 'state',
           'city'          => 'city',
           'zip'           => '90210',
           'country'       => 'AUS'//country code,));
$repo->createUser($user)

#####获取用户

$repo = new UserRepository();
$user = $repo->getUserById('User id');

#####获取用户列表

$repo = new UserRepository();
$users = $repo->getListOfUsers();

#####删除用户

$repo = new UserRepository();
$repo->deleteUser('User_id');

#####获取用户的卡账户

$repo = new UserRepository();
$usersCardAccounts = $repo->getListOfCardAccountsForUser('User_id');

#####获取用户的PayPal账户

$repo = new UserRepository();
$usersPayPalAccounts = $repo->getListOfPayPalAccountsForUser('User_id');

#####获取用户的银行账户

$repo = new UserRepository();
$usersBankAccounts = $repo->getListOfBankAccountsForUser('User_id');

#####获取用户的项

$repo = new UserRepository();
$items = $repo->getListOfItemsForUser('User_id');

#####设置用户的支付账户

$repo = new UserRepository();
$repo->setDisbursementAccount('user_id', 'account_id');

##项操作

#####进行支付

$repo = new ItemRepository();
$repo->makePayment('External_item_id', 'Card_account_id', 'User_id')

#####请求支付

$repo = new ItemRepository();
$requestPayment = $repo->requestPayment('Item_id', 'Seller_id');

#####释放支付

$repo = new ItemRepository();
$releasePayment = $repo->releasePayment('Item_id', 'buyer_id', 'Release amount');

#####请求释放

$repo = new ItemRepository();
$requestRelease = $repo->requestRelease('Item_id', 'Seller_id', 'Release amount');

#####取消

$repo = new ItemRepository();
$repo->cancelItem('Item_id');

#####确认汇款

$repo = new ItemRepository();
$acknowledgeWire = $repo->acknowledgeWire('Item_id', 'Buyer_id');

#####确认PayPal

$repo = new ItemRepository();
$acknowledgePayPal = $repo->acknowledgePayPal('Item_id', 'Buyer_id');

#####撤销汇款

$repo = new ItemRepository();
$repo->revertWire('Item_id', 'Buyer_id');

#####请求退款

$repo = new ItemRepository();
$repo->requestRefund('Item_id',  'Buyer_id',  'Refund amount',  'Refund message');

#####退款

$repo = new ItemRepository();
$repo = refund( 'Item id',  'Seller id',  'Refund Amount',  'Refund message')

##卡账户

$repo = new CardAccountRepository();
$user = new CardAccount($arr = array(
           'user_id'       => id,
           'full_name'     => 'Bobby Buyer',
           'number'        => '4111111111111111',
           'expiry_month'  => '06'
           'expiry_year'   => '2016'
           'cvv' 			=> '123'));
$repo->createCardAccount($user)

#####创建卡账户

$repo = new CardAccountRepository();
$card = $repo->getCardAccountById('Account_id')

#####获取卡账户

$repo = new CardAccountRepository();
$repo->deleteCardAccount('Account_id')

#####删除卡账户

$repo = new CardAccountRepository();
$users = $repo->getUserForCardAccount('Card Account');

#####获取卡账户的用户

$repo = new BankAccountRepository();
$bankAccount = new BankAccount($arr = array(
			   'user_id' 			=> 'External_seller_id',
           	   'bank_name'			=> 'Test Bank',
          	   'account_name'		=> 'Sally Seller',
           	   'routing_number' 	=> '123456',
           	   'account_number'		=> '12345678',
           	   'account_type'		=> 'checking',
           	   'holder_type'		=> 'personal',
           	   'bank_country'		=> 'AUS'))
$repo->createBankAccount($bankAccount)

##银行账户

$repo = new BankAccountRepository();
$bankAccount = $repo->getBankAccountById('Account_id');

#####创建银行账户

$repo = new BankAccountRepository();
$repo->deleteBankAccount('Account_id');

#####获取银行账户

$repo = new BankAccountRepository();
$user = $repo->getUserForBankAccount('Account_id');

#####删除银行账户

$repo  = new PayPalAccountRepository();
$params  = array(
    'user_id'=> 'User id',
    'active'=>'true',
    'paypal'=>array(
        'email'=>'User email'
        )
    );
$ppalAccount = new PayPalAccount($params);
$repo->createPayPalAccount($ppalAccount);

#####获取银行账户的用户

$repo = new PayPalAccountRepository();
$paypalAccount = $repo->getPayPalAccountById('account_id');

##PayPal账户

$repo = new PayPalAccountRepository();
$repo->deletePayPalAccount('Account id')

#####获取PayPal账户

$repo = new PayPalAccountRepository();
$users = $repo->getUserForPayPalAccount('Account id')

#####删除PayPal账户

$repo = new FeeRepository();
$fees = $repo->getListOfFees();

#####获取PayPal账户的用户

$repo = new FeeRepository();
$fee = $repo->getFeeById('Fee id');

##费用

$enum = new FeeType();
$repo = new FeeRepository();
$data = array(
    'id'=>'fee id',
    'amount'=>1000,
    'name'=>'fee name',
    'fee_type'=>$enum->Fixed,
    'cap'=>'1',
    'max'=>'3',
    'min'=>'2',
    'to'=>'buyer'
    );
$fee = new Fee($data);
$repo->createFee($fee);

#####获取费用列表

$repo = new TransactionRepository();
$trans = $repo->getListOfTransactions();

#####获取费用

$repo = new TransactionRepository();
$transaction = $repo->getTransaction('transaction_id');

#####创建费用

$repo = new TransactionRepository();
$users = $repo->getUserForTransaction('transaction id');

##交易

$repo = new TransactionRepository();
$fees = $repo->getFeeForTransaction('transaction id');

#####获取交易列表