通过 
搜索
搜索lopes / asaas
Asaas API
dev-main
2023-05-25 17:23 UTC
Requires
- guzzlehttp/guzzle: ^6.5||^7.4
- illuminate/config: ~5|^6|^7|^8|^9|^10.0
- illuminate/support: ^6|^7|^8|^9
Requires (Dev)
- orchestra/testbench: ^4|^5|^6|^7
- phpunit/phpunit: ^9.5
This package is auto-updated.
Last update: 2024-09-25 20:07:23 UTC
README
使用示例。
use Lopes\Asaas\Facade\Asaas Asaas::payment()->find()
用于Smartgps Laravel项目的SDK
此包允许以简化的方式调用asaas API，封装了连接和数据处理过程。提供的功能符合服务提供的API命名。
此文档详细介绍了实现情况，有关请求和数据处理格式的详细信息，请参阅Asaas提供的交互式请求文档。
资源
- 请求封装。
- 连接错误处理。
- 数据类型处理（未实现）。
- 将文档转换为通过multipart/form-data发送（未实现）。
- 单元测试（不完整，未验证响应格式）。
依赖关系
- PHP 7.1或更高版本。
- Illuminate/config 8.0或更高版本。
- GuzzleHttp/Guzzle 7.4或更高版本。
开发者建议
- 保持单元测试覆盖率在100%以进行安全重构。
- 使用Asaas API提供的测试路由（https://private-anon-d1f6145713-asaasv3.apiary-mock.com/api/v3/）。
安装
通过直接从私有仓库导入安装
要安装包，需要在composer.json中指定项目可用的私有或公共仓库。
"repositories": { "Lopes/asaas" : { "type" : "vcs", "url" : "https://github.com/elvis-s-lopes/asaas-sdk" } }
同时，在require标签中指定依赖项。
"require": { "Lopes/asaas": "1.0^", }
如何使用
使用Artisan命令自动生成asaas.php配置文件。
php artisan vendor:publish
实例化包中的Asaas类，并按顺序调用每个函数。函数定义在本文档的最后。
// Referencie o namespace do pacote use Lopes\Asaas; // Instancie uma novo objeto Asaas $asaas = new Asaas(); //Faça as chamadas em funções encadeadas dependendo do serviço da API $asaas->client()->create($data); $assas->invoice()->find();
可用函数
- 数据模型请检查API文档
支付
//Rota POST /payments $assas->payment()->create(array $paymentData); //Rota GET /payments/id ou /payments quando id é null $assas->payment()->find(string $paymentId = null) //Rota GET /payments?customer= $assas->payment()->findByCustomerId(string $customerId) //Rota POST /payments/id $assas->payment()->update(string $paymentId, array $paymentData) //Rota DELETE /payments/id $assas->payment()->remove(string $paymentId) //Rota POST /payments/id/restore $assas->payment()->restore(string $paymentId) //Rota POST /payments/id/restore $assas->payment()->reversePayment(string $paymentId) //Rota GET /payments/id/identificationField $assas->payment()->bankSlipCode(string $paymentId) //Rota GET /payments/id/pixQrCode $assas->payment()->pixQrCode(string $paymentId) //Rota POST /payments/id/receiveInCash $assas->payment()->confirmReceivedInCash(string $paymentId) //Rota POST /payments/id/undoReceivedInCash $assas->payment()->undoReceivedInCash(string $paymentId)
客户
//Rota POST /customers $asaas->customer()->create(array $customerData) //Rota GET /customers/id ou /customers $asaas->customer()->find(string $customerId = null) //Rota GET /customers?name= $asaas->customer()->findByName(string $customerName) //Rota GET /customers?email= $asaas->customer()->findByEmail(string $customerEmail) //Rota GET /customers?cpfCnpj= $asaas->customer()->findByCpfCnpj(string $customerCpfCnpj) //Rota POST customers/id $asaas->customer()->update(string $customerId, array $values) //Rota DELTE /customers/id $asaas->customer()->remove(string $customerId) //Rota POST /customers/id/restore $asaas->customer()->restore(string $customerId)
分期付款
//Rota GET /installments/id ou /installments $asaas->installments()->find(string $installmentId = null) //Rota DELETE /installments/id $asaas->installments()->remove(string $installmentId) //Rota POST /installments/id/refund $asaas->installments()->reversePayment(string $installmentId)
订阅
//Rota POST /subscriptions $asaas->subscription()->create(array $subscriptionData) //Rota GET /subscriptions/id ou subscriptions $asaas->subscription()->find(string $subscriptionId = null) //Rota GET /subscriptions?customer= $asaas->subscription()->findByCustomerId(string $customerId) //Rota GET /subscriptions/id/payments $asaas->subscription()->payments(string $subscriptionId) //Rota POST /subscriptions/id $asaas->subscription()->update(string $subscriptionId, array $subscriptionData) //Rota DELETE /subscriptions/id $asaas->subscription()->remove(string $subscriptionId) //Rota GET subscriptions/id/invoices $asaas->subscription()->invoices(string $subscriptionId) //Rota POST /subscriptions/id/invoiceSettings $asaas->subscription()->setInvoiceSettings(string $subscriptionId, array $values) //Rota GET subscriptions/id/invoiceSettings $asaas->subscription()->invoiceSettings(string $subscriptionId) //Rota DELETE /subscriptions/id/invoiceSettings $asaas->subscription()->removeInvoiceSettings(string $subscriptionId)
支付链接
//Rota POST /paymentLinks $asaas->paymentLink()->create(array $paymentLinkData) //Rota PUT /paymentLinks/id $asaas->paymentLink()->update(string $paymentLinkId, array $paymentLinkData) //Rota GET /paymentLinks/id ou /paymentLinks $asaas->paymentLink()->find(string $paymentLinkId = null) //Rota GET /paymentLinks?active=true $asaas->paymentLink()->findActive() //Rota DELETE /paymentLinks/id $asaas->paymentLink()->remove(string $paymentLinkId) //Rota POST /paymentLinks/id/restore $asaas->paymentLink()->restore(string $paymentLinkId) //Rota POST /paymentLinks/id/images $asaas->paymentLink()->image(string $paymentLinkId) //Rota GET /paymentLinks/id/images/imageId ou /paymentLinks/id/images $asaas->paymentLink()->findImages(string $paymentLinkId, string $imageId = null) //Rota DELETE paymentLinks/id/images $asaas->paymentLink()->removeImage(string $imageId) //Rota POST /paymentLinks/id/images/imageId/setAsMain $asaas->paymentLink()->setMainImage(string $paymentLinkId, string $imageId)
通知
//Rota GET /customers/id/notifications $asaas->notification()->find(string $customerId) //Rota POST /notifications/id $asaas->notification()->update(string $notificationId, array $notificationConfig)
预付款
//Rota POST /anticipations $asaas->anticipation()->create(array $anticipationData) //Rota POST /anticipations/simulate $asaas->anticipation()->simulate(array $simulateOptions) //Rota GET /anticipations/id $asaas->anticipation()->find(string $anticipationId) //Rota GET /anticipations?payment= $asaas->anticipation()->findByPaymentId(string $paymentId) //Rota GET /anticipations?installment= $asaas->anticipation()->findByInstallmentId(string $installmentId) //Rota GET /anticipations?status= $asaas->anticipation()->findByStatus(string $status)
支付催收
//Rota POST /paymentDunnings $asaas->paymentDunning()->create(array $paymentDunningData) //Rota POST /paymentDunnings/simulate $asaas->paymentDunning()->simulate(array $simulateOptions) //Rota GET /paymentDunnings/id ou /paymentDunnings $asaas->paymentDunning()->find(string $paymentDunningId = null) //Rota GET /paymentDunnings?status= $asaas->paymentDunning()->findByStatus(string $status) //Rota GET /paymentDunnings?type= $asaas->paymentDunning()->findByType(string $type) //Rota GET /paymentDunnings?payment= $asaas->paymentDunning()->findByPaymentId(string $paymentId) //Rota GET /paymentDunnings/id/history $asaas->paymentDunning()->eventHistory(string $paymentDunningId) //Rota GET /paymentDunnings/id/partialPayments $asaas->paymentDunning()->receivedPartialPayment(string $paymentDunningId) //Rota GET /paymentDunnings/paymentsAvailableForDunning $asaas->paymentDunning()->paymentsAvailableForDunning() //Rota POST /paymentDunnings/id/documents $asaas->paymentDunning()->resendDocuments(string $paymentDunningId, array $documentFiles) //Rota POST /paymentDunnings/id/cancel $asaas->paymentDunning()->cancel(string $paymentDunningId)
账单支付
//Rota POST /bill $asaas->billPayments()->create(array $billData) //Rota POST /bill/simulate $asaas->billPayments()->simulate(array $simulateOptions) //Rota GET /bill/id ou /bill $asaas->billPayments()->find(string $billId = null) //Rota POST /bill/id/cancel $asaas->billPayments()->cancel(string $billId)
Serasa
//Rota POST /creditBureauReport $asaas->serasa()->check(array $customerData) //Rota GET /creditBureauReport/id ou /creditBureauReport $asaas->serasa()->find(string $checkId = null)
金融交易
//Rota GET /financialTransactions $asaas->financialTransaction()->find()
账户
//Rota POST /accounts $asaas->account()->create(array $accountData) //Rota GET /accounts $asaas->account()->relatedAccounts() //Rota GET /finance/getCurrentBalance $asaas->account()->balance() //Rota POST /transfers $asaas->account()-> transfer(array $transferOptions) //Rota GET /transfers/id ou /transfers $asaas->account()->findTransfer(string $transferId = null) //Rota GET /transfers?dateCreated= $asaas->account()->findTransferByDate(string $transferDate) //Rota GET /transfers?type= $asaas->account()->findTransferByType(string $transferType) //Rota GET /myAccount $asaas->account()->comercialData() //Rota POST /myAccount/paymentCheckoutConfig $asaas->account()->setPaymentCheckoutConfig(array $paymentCheckoutData) //Rota GET /myAccount/paymentCheckoutConfig $asaas->account()->findPaymentCheckoutConfig()
发票
//Rota POST /invoices $asaas->invoice()->create(array $invoiceData) //Rota PUT /invoices/id $asaas->invoice()->update(string $invoiceId, array $invoiceData) //Rota GET /invoices/id ou /invoices $asaas->invoice()->find(string $invoiceId = null) //Rota GET /invoices?payment= $asaas->invoice()->findByPaymentId(string $paymentId) //Rota GET /invoices?installment= $asaas->invoice()->findByInstallmentId(string $installmentId) //Rota GET /invoices?status= $asaas->invoice()->findByStatus(string $status) //Rota POST /invoices/id/authorize $asaas->invoice()->authorize(string $invoiceId) //Rota POST /invoices/id/cancel $asaas->invoice()->cancel(string $invoiceId) //Rota GET /invoices/municipalServices?description= $asaas->invoice()->municipalServices(string $description)
税务信息
//Rota GET /ustomerFiscalInfo/municipalOptions $asaas->fiscalInformation()->municipalServices() //Rota POST /customerFiscalInfo $asaas->fiscalInformation()->create(array $invoiceData) //Rota POST /customerFiscalInfo $asaas->fiscalInformation()->update(array $invoiceData) //Rota GET /customerFiscalInfo $asaas->fiscalInformation()->find()
Webhook
//Rota POST /webhook $asaas->webhook()->config(array $webhookConfig) //Rota GET /webhook $asaas->webhook()->findConfig() //Rota POST /webhook/invoice $asaas->webhook()->invoiceConfig(array $invoiceConfig) //Rota GET /webhook/invoice $asaas->webhook()->findInvoiceConfig() //Rota POST /webhook/transfer $asaas->webhook()->transferConfig(array $transferConfig) //Rota GET /webhook/transfer $asaas->webhook()->findTransferConfig()