packa / packa-business
本文档列出了Paga为商业客户提供的不同RESTful网络服务,并指导您设置这些服务。
Requires
- php: >=8.1
- monolog/monolog: ^3.0@dev
This package is auto-updated.
Last update: 2024-09-05 10:44:35 UTC
README
库暴露的商业服务
- registerCustomer
- registerCustomerAccountPhoto
- registerCustomerIdentification
- moneyTransfer
- airtimePurchase
- merchantPayment
- validateDepositToBank
- depositToBank
- accountBalance
- transactionHistory
- recentTransactionHistory
- getMerchants
- getMerchantServices
- getBanks
- getOperationStatus
- getMobileOperators
- onboardMerchant
- moneyTransferBulk
有关上述服务的更多信息,请访问Paga 开发者网站
如何使用
composer require paga/paga-business
require_once __DIR__ .'/vendor/autoload.php'
$businessClient = PagaBusinessClient::builder()
->setApiKey("<apiKey>")
->setPrincipal("<publicId>")
->setCredential("<password>")
->setTest(true)
->build();
如上所示,您设置Paga提供的主体和凭证,如果将 setIsTest() 的值传递为 true,则库将使用测试 URL 作为所有调用的基本 URL。否则将设置为 false,将使用您 传递 的实时 URL 值作为基本 URL。
商业服务函数
注册客户
注册客户操作允许第三方在 Paga 上注册客户。新客户将被联系以设置其身份验证凭证。要使用此功能,请在 BusinessClient 中调用 registerCustomer,它将返回注册客户的 JSONObject。
$response = $businessClient ->registerCustomer(
"referenceNumber",
"customerPhoneNumber",
"customerFirstName",
"customerLastName",
"customerEmail",
"customerDateOfBirth",
)
注册客户账户照片
一个操作,让企业上传已注册客户账户的照片。如果账户照片不可用或在初始注册尝试中上传失败或被拒绝,则非常有用。要使用此功能,请在 BusinessClient 库中调用 registerCustomerAccountPhoto 函数,它将返回 JSONObject。
$response = $businessClient ->registerCustomerAccountPhot(
$reference_number,
$customerPhoneNumber,
$passportPhoto_path
);
注册客户身份证明
一个操作,让企业上传已注册客户账户的身份证明照片。要使用此功能,请在 BusinessClient 库中调用 registerCustomerIdentification 函数,它将返回 JSONObject。
$response = $businessClient -> registerCustomerIdentification(
$reference_number,
$customerPhoneNumber,
$customerIdType,
$customerIdNumber,
$customerIdExpirationDate,
$idPhoto_path
);
金钱转账
金钱转账操作允许集成的第三方利用 Paga 平台将资金从各种来源转移到另一方。资金转账可能由集成的第三方本身执行,或代表具有适当身份验证的另一位客户。资金来源可能是发送者的 Paga 账户或发送者在 Paga 平台上预先注册的另一个来源。要使用此功能,请在 BusinessClient 库中调用 moneyTransfer,它将返回金钱转账的 JSONObject。
$response = $businessClient ->moneyTransfer(
$referenceNumber,
$amount,
$destinationAccount,
$senderPrincipal,
$senderCredentials,
$currency
);
空中购买
空中购买操作允许集成的第三方利用 Paga 平台为任何主要网络上的任何电话号码购买话费。购买可以由集成的第三方本身资助,或代表具有适当身份验证的另一位客户。资金来源可能是购买者的 Paga 账户或发送者在 Paga 平台上预先注册的另一个来源。要使用此功能,请在 BusinessClient 库中调用 airtimePurchase 函数,它将返回购买话费的 JSONObject。
$response = $businessClient ->airtimePurchase(
$referenceNumber,
$amount,
$phoneNumber
);
商家支付
商家支付操作允许集成第三方利用Paga平台向注册商家支付款项。购买可以通过集成第三方自身进行,或者代表其他客户进行,前提是拥有适当的身份验证。资金的来源可以是购买者的Paga账户,或者是发件人在Paga平台上预先注册的其他来源。要使用此功能,请调用BusinessClient库中的merchantPayment函数,该函数将返回一个表示商家支付的JSONObject。
$response = $businessClient-> merchantPayment($reference_number,
$amount,
$merchantAccount,
$merchantReferenceNumber,
$currency,
$merchantService
);
验证银行存款
验证银行存款操作允许集成第三方使用类似实际银行存款操作提供的参数来预先验证潜在银行存款操作。这将返回一个结果,指示使用相同参数的实际银行存款操作是否可能成功,如果不成功,原因是什么。这还将验证提供的银行的银行账户号码,并返回该账户的账户持有人姓名,如银行存储。这还将返回实际银行存款操作中可能收取的任何费用。要使用此功能,请调用BusinessClient库中的validateDepositToBank函数,该函数将返回一个表示验证银行存款的JSONObject。
$response = $businessClient-> validateDepositToBank(
$reference_number,
$amount,
$destinationBankUUID,
$destinationBankAccountNumber
);
银行存款
银行存款操作允许集成第三方利用Paga平台向任何银行账户存入资金。资金将从企业的Paga账户通过操作参数中指定的银行账户存入银行。要使用此功能,请调用BusinessClient库中的depositToBank函数,该函数将返回一个表示银行存款的JSONObject。
$response = $businessClient-> depositToBank(
$reference_number,
$amount,
$destinationBankUUID,
$destinationBankAccountNumber,
$recipientPhoneNumber,
$currency
)
账户余额
账户余额操作允许集成第三方利用Paga平台检查Paga账户或任何其他在Paga平台上预先注册并支持余额查询的账户类型的余额。账户余额检查可以是针对集成第三方的账户或代表其他客户进行,前提是拥有适当的身份验证。要使用此功能,请调用BusinessClient库中的accountBalance函数,该函数将返回一个JSONObject。
$response = $businessClient-> accountBalance($reference_number);
交易历史
交易历史操作允许集成第三方利用Paga平台检查在选定日期范围内他们的Paga账户的交易历史。交易历史可以是针对集成第三方的账户或代表其他客户进行,前提是拥有适当的身份验证。交易结果限制在最近的10,000条结果。要使用此功能,请调用BusinessClient库中的transactionHistory函数,该函数将返回一个表示交易历史的JSONObject。
$response = $businessClient-> transactionHistory($reference_number);
最近交易历史
最近交易历史操作允许集成第三方利用Paga平台检查他们的Paga账户上的最后5笔交易。最近交易历史可以是针对集成第三方的账户或代表其他客户进行,前提是拥有适当的身份验证。要使用此功能,请调用BusinessClient库中的recentTransactionHistory函数,该函数将返回一个表示最近交易历史的JSONObject。
$response = $businessClient-> recentTransactionHistory($reference_number);
获取商家
获取商家操作允许集成第三方利用Paga平台获取Paga平台上的注册商家列表,通常用于参数化商家支付操作。要使用此功能,请调用BusinessClient库中的getMerchants函数,该函数将返回一个JSONObject。
$response = $businessClient-> getMerchants($reference_number);
获取商家服务
“获取商家服务”操作允许集成第三方利用Paga平台获取在Paga平台上注册的服务列表以及服务详情,通常用于参数化商家支付操作。要使用此功能,请在BusinessClient库中调用getMerchantServices
函数,该函数将返回一个JSONObject。
$response = $businessClient-> getMerchantServices(
$reference_number,
$merchantPublicId
);
获取银行
“获取银行”操作允许集成第三方利用Paga平台获取Paga平台上可用的银行列表,通常用于参数化银行存款操作。要使用此功能,请在BusinessClient库中调用getBanks
函数,该函数将返回一个JSONObject。
$response = $businessClient-> getBanks($reference_number);
获取操作状态
“获取操作状态”操作允许集成第三方使用操作的参考号检查先前操作的状态。要使用此功能,请在BusinessClient库中调用getOperationStatus
函数,该函数将返回一个JSONObject。
$response = $businessClient -> getOperationStatus($reference_number);
获取移动运营商
“获取移动运营商”操作允许集成第三方利用Paga平台获取Paga平台上可用的移动运营商列表,通常用于参数化业务API的各种操作。要使用此功能,请在BusinessClient库中调用getMobileOperators
函数,该函数将返回一个JSON对象。
$response = $businessClient -> getMobileOperators($reference_number);
批量转账
“批量转账”操作允许集成第三方利用Paga平台同时向多个收款人执行上述转账操作。此操作的限制为每批操作300个支付项目。要使用此功能,请在BusinessClient库中调用moneyTransferBulk
函数,该函数将返回一个JSON对象。
$bulkReferenceNumber = "ref-123";
$items_arr = array(
array('referenceNumber'=>$referenceNumber_1,
'amount'=>$amount_1,
'destinationAccount'=>$phonenumber_1,
'senderPrincipal'=>$senderPrincipal_1,
'senderCredentials'=>$senderCredentials_1,
'currency'=>$currency_1
),
array('referenceNumber'=>$referenceNumber_2,
'amount'=>$amount_2,
'destinationAccount'=>$phonenumber_2,
'senderPrincipal'=>$senderPrincipal_2,
'senderCredentials'=>$senderCredentials_2,
'currency'=>$currency_2
)
);
$response = $businessClient -> moneyTransferBulk($bulkReferenceNumber, $items_arr);
点击此处获取有关MoneyTransferItem
的更多信息。
商家入驻
“商家入驻”操作允许聚合组织在Paga平台上创建子组织。
此操作仅适用于Paga平台上的商家聚合器。
$legalEntity = array (
"name"=> "",
"description"=>"",
"addressLine1"=>"",
"addressLine2"=>"",
"addressCity"=>"",
"addressState"=>"",
"addressZip"=>"",
"addressCountry"=>"");
$legalEntityRepresentative = array (
"firstName"=>"",
"lastName"=>"",
"dateOfBirth"=>"",
"phone"=>"",
"email"=>""
);
$integration = array(
"type"=>""
);
$merchantInfo = array( "legalEntity"=> legalEntity, "legalEntityRepresentative"=> $legalEntityRepresentative);
$response = $businessClient_test -> onboardMerchant($reference, $merchantExternalId, $merchantInfo, $integration);
点击此处获取有关OnboardMerchant
的更多信息。