README

这是Briqpay的API文档。您可以在我们的网站上了解更多关于我们和我们的产品：[https://briqpay.com](https://briqpay.com)。为了获取playground API的凭证，请在[https://app.briqpay.com](https://app.briqpay.com)注册。

简介

Briqpay Checkout是针对您的B2B电商的行内结账解决方案。Briqpay Checkout允许您控制您的支付方式和信用规则，同时优化客户的用户体验。

SDK

Briqpay基于这些swagger定义提供标准SDK，用于PHP和.NET。您可以相应地下载它们或使用我们的swagger定义来生成自己的版本。

对于.NET

Install-Package Briqpay

对于PHP

composer require briqpay/php-sdk

标准用例

作为集成的第一步，您需要创建一个结账会话。\n\n在这个会话中，您需要向Briqpay提供必要的基本信息。在Briqpay的响应中，您将收到一个HTML片段，该片段需要插入到您的前端中。Briqpay提供的片段将在iframe中渲染，用户将在其中完成购买。一旦完成，Briqpay将把客户重定向到您定义的确认页面。

alt

JavaScript SDK

集成的第一步是在您的网站中添加我们的JS，在关闭`<head>`标签之前。这确保了我们的JS库可以加载结账。

`<script src=\"https://api.briqpay.com/briq.min.js\"></script>`

Briqpay通过我们的JavaScript SDK提供了一些方法。该库由我们的iframe添加，并在`window._briqpay`上可用。如果您在结账页面上提供更新购物车或订单金额的可能性，JS库将帮助您。

如果您的商店根据客户的送货地点向客户收取不同的费用，您可以通过监听`addressupdate`事件来重新计算总成本。

    window._briqpay.subscribe('addressupdate', function (data) {
  console.log(data)
    })

如果您的前端需要在注册完成后执行操作，请监听`signup_finalized`事件。

    window._briqpay.subscribe('signup_finalized', function (status) {
      // redirect or handle status 'success' / 'failure'
    })

如果您允许客户更改总购物车价值，您可以使用JS库在您执行后端更新调用时暂停iframe。如下所述： alt 如果您在7秒内没有调用`_briqpay.resume()`，iframe将自动恢复。

测试数据

为了验证您的集成，您需要使用测试数据对我们的信用引擎进行测试。

公司识别号码

1111111111 - 接收高信用评分公司（评分为100）
2222222222 - 使用信用评分低的公司测试环境（评分为10）

卡信息

在我们的playground设置中，您的账户默认设置有Stripe集成。为了测试卡表单，您可以使用以下卡号：

4000002500003155 - 模拟3ds身份验证窗口
4000000000000069 - 充值被拒绝，原因是卡片过期。

您可以使用任何有效的有效期和CVV代码

身份验证

Brickpay使用JWT来验证对平台的调用。验证令牌在48小时后过期，此时您可以使用/auth端点为给定资源生成新令牌。

基本认证 - 仅用于认证端点以获取Bearer令牌
JWT Bearer令牌 - 所有对API的调用都使用此方法

安装与使用

要求

PHP 7.3及以后版本。应该也能与PHP 8.0兼容，但尚未进行测试。

Composer

要使用Composer安装绑定，请将以下内容添加到composer.json

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/php-sdk.git"
    }
  ],
  "require": {
    "GIT_USER_ID/php-sdk": "*@dev"
  }
}

然后运行composer install

手动安装

下载文件并包含autoload.php

<?php
require_once('/path/to/Briqpay/vendor/autoload.php');

入门指南

请按照安装流程进行操作，然后运行以下命令

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure HTTP basic authorization: basicAuth
$config = Briqpay\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Briqpay\Api\AuthenticationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->getAuthToken();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->getAuthToken: ', $e->getMessage(), PHP_EOL;
}

API端点

所有URI均相对于https://playground-api.briqpay.com

类	方法	HTTP请求	描述
AuthenticationApi	getAuthToken	GET /auth	生成Bearer令牌
AuthenticationApi	getAuthTokenForSession	GET /auth/{sessionid}	为会话生成新的auth令牌
AuthenticationApi	getSignupSessionAuth	GET /auth/signup/{sessionid}	为注册会话获取新的auth令牌
CheckoutApi	cancelRecurringToken	POST /checkout/v1/recurring/token/cancel	取消周期性令牌
CheckoutApi	createSession	POST /checkout/v1/sessions	创建支付会话
CheckoutApi	patchCheckoutSession	POST /checkout/v1/sessions/patch	修补会话
CheckoutApi	purchaseDecision	POST /checkout/v2/sessions/{sessionid}/decision/purchase	批准或拒绝会话的购买
CheckoutApi	readRecurringToken	POST /checkout/v1/recurring/token	读取周期性令牌
CheckoutApi	readSession	POST /checkout/v1/readsession	读取会话
CheckoutApi	updateSession	POST /checkout/v1/sessions/update	更新会话
CheckoutApi	yourchargewebhookPost	POST /yourchargewebhook	计费结果
HostedPageApi	createHostedPage	POST /hostedpage/v1/checkout	创建托管结账页面
OrderManagementApi	captureOrder	POST /order-management/v1/capture-order	捕获已放置的订单
OrderManagementApi	refundOrder	POST /order-management/v1/refund-order	退还已捕获的订单
SignupApi	createSignup	POST /signup/v1/session	创建新的注册会话
SignupApi	readSignup	GET /signup/v1/session	读取正在进行的注册会话
SignupApi	sendValidateResponse	POST /signup/v1/hooks/validated	验证结果
SignupApi	yoursignupwebhookPost	POST /yoursignupwebhook	注册Webhook请求

模型

授权

基本认证

类型: HTTP基本认证

Bearer认证

类型: Bearer认证（JWT）

测试

要运行测试，请使用

composer install
vendor/bin/phpunit

作者

hello@briqpay.com

关于此包

此PHP包是由OpenAPI Generator项目自动生成的

API版本: 1.0.0
构建包: org.openapitools.codegen.languages.PhpClientCodegen

briqpay / php-sdk

维护者

详细信息