trollweb / afterpay-api
为 https://developer.afterpay.io/api 生成的 Swagger API 库
2.1.1
2020-09-23 10:30 UTC
Requires
- php: >=5.4
- ext-curl: *
- ext-json: *
- ext-mbstring: *
Requires (Dev)
- friendsofphp/php-cs-fixer: ~1.12
- phpunit/phpunit: ~4.8
- satooshi/php-coveralls: ~1.0
- squizlabs/php_codesniffer: ~2.6
README
未提供描述(由 Swagger Codegen 生成 https://github.com/swagger-api/swagger-codegen)
此 PHP 包由 Swagger Codegen 项目自动生成
- API 版本:v3
- 构建包:io.swagger.codegen.languages.PhpClientCodegen
需求
PHP 5.4.0 及以上版本
安装与使用
Composer
要使用 Composer 安装绑定,请将以下内容添加到 composer.json
{
"repositories": [
{
"type": "git",
"url": "https://github.com/afterpay-api/afterpay-api-lib.git"
}
],
"require": {
"afterpay-api/afterpay-api-lib": "*@dev"
}
}
然后运行 composer install
手动安装
下载文件并包含 autoload.php
require_once('/path/to/SwaggerClient-php/autoload.php');
测试
要运行单元测试
composer install
./vendor/bin/phpunit
入门
请按照 安装说明 进行操作,然后运行以下命令
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Trollweb\AfterPayApi\Api\CheckoutApi();
$request = new \Trollweb\AfterPayApi\Model\AuthorizePaymentRequest(); // \Trollweb\AfterPayApi\Model\AuthorizePaymentRequest |
try {
$result = $api_instance->checkoutAuthorizePayment($request);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling CheckoutApi->checkoutAuthorizePayment: ', $e->getMessage(), PHP_EOL;
}
?>
API 端点文档
所有 URI 都是相对于 https://api.afterpay.io
| 类 | 方法 | HTTP 请求 | 描述 |
|---|---|---|---|
| CheckoutApi | checkoutAuthorizePayment | POST /api/v3/checkout/authorize | 批准特定客户和购物车的支付。主要用例为一步和两步授权。应用全面的欺诈和信用评分。如果在线商店客户输入错误地址数据,系统将提供修正地址的建议。 |
| CheckoutApi | checkoutAvailablePaymentMethods | POST /api/v3/checkout/payment-methods | 返回指定购物车价值和客户端可用的优惠的可用支付方式。返回月供金额、利息和费用。发送客户数据和购物车内容以增强结果是可选的。如果在线商店客户输入错误的地址数据,系统将提供修正地址的建议。主要用例为两步授权。 |
| CheckoutApi | checkoutCreateContract | POST /api/v3/checkout/{checkoutId}/contract | 创建可向客户显示的分期付款和/或直接借记合同。 |
| CommonApi | commonCustomerLookup | POST /api/v3/lookup/customer | 根据社会保险号码或手机号码返回客户的地址。 |
| CommonApi | commonGetStatus | GET /api/v3/status | 获取服务的状态 |
| CommonApi | commonGetVersion | GET /api/v3/version | 获取服务的版本 |
| CommonApi | commonValidateAddress | POST /api/v3/validate/address | 检查交付的客户地址以及重复地址的音译和关联识别。此外,还可以处理特定于客户端的负面或正面列表的检查。通常,地址检查用于纯粹验证地址数据,例如用于注册流程。 |
| CommonApi | commonValidateBankAccount | POST /api/v3/validate/bank-account | 在直接借记支付的情况下验证和评估账户和银行详情。可以传输银行代码和账户号码的组合或 IBAN 和 BIC。 |
| CustomerAccountApi | customerAccountAddEvent | POST /api/v3/customer-account/{accountNumber}/event | 向账户添加事件 |
| CustomerAccountApi | customerAccountAddTransaction | POST /api/v3/customer-account/{accountNumber}/transaction | 向账户添加交易 |
| CustomerAccountApi | customerAccountApplyForCredit | POST /api/v3/customer-account | 申请客户账户信用 |
| CustomerAccountApi | customerAccountCreateUser | POST /api/v3/customer-account/{accountNumber}/user | 将用户添加到账户 |
| CustomerAccountApi | customerAccountCreditLimit | GET /api/v3/customer-account/{accountNumber}/credit-limit | 获取账户剩余信用额度 |
| CustomerAccountApi | customerAccountDeleteTransaction | DELETE /api/v3/customer-account/{accountNumber}/transaction/{transactionId} | 取消账户的交易 |
| CustomerAccountApi | customerAccountLookupBySSN | GET /api/v3/customer-account/{ssn} | 通过SSN(社会保险号)查找客户账户 |
| 订单管理API | orderManagementAddShippingDetails | POST /api/v3/orders/{orderNumber}/captures/{captureNumber}/shipping-details | 将新的运输详情信息添加到捕获。 |
| 订单管理API | orderManagementCapture | POST /api/v3/orders/{orderNumber}/captures | 完成已授权的付款。通常在订单发货时进行。可以是订单金额的全部或部分捕获。 |
| 订单管理API | orderManagementDeleteShippingDetails | DELETE /api/v3/orders/{orderNumber}/captures/{captureNumber}/shipping-details/{shippingNumber} | 从特定捕获中删除运输详情信息。 |
| 订单管理API | orderManagementGetCapture | GET /api/v3/orders/{orderNumber}/captures/{captureNumber} | 返回订单的所有或特定捕获付款。 |
| 订单管理API | orderManagementGetOrder | GET /api/v3/orders/{orderNumber} | 返回指定订单的内容。 |
| 订单管理API | orderManagementGetRefund | GET /api/v3/orders/{orderNumber}/refunds/{refundNumber} | 返回订单的所有或特定退款。 |
| 订单管理API | orderManagementGetShippingDetails | GET /api/v3/orders/{orderNumber}/captures/{captureNumber}/shipping-details/{shippingNumber} | 返回捕获的所有或特定运输详情信息。 |
| 订单管理API | orderManagementGetVoid | GET /api/v3/orders/{orderNumber}/voids/{voidNumber} | 返回订单的所有或特定已取消(已撤销)的授权。 |
| 订单管理API | orderManagementRefund | POST /api/v3/orders/{orderNumber}/refunds | 部分或全额退款已捕获的付款。 |
| 订单管理API | orderManagementUpdateShippingDetails | PATCH /api/v3/orders/{orderNumber}/captures/{captureNumber}/shipping-details/{shippingNumber} | 更新特定捕获的运输详情信息。 |
| 订单管理API | orderManagementVoid | POST /api/v3/orders/{orderNumber}/voids | 取消(撤销)未捕获的授权。 |
| 产品API | productAvailableInstallmentPlans | POST /api/v3/lookup/installment-plans | 返回特定产品/购物车价值的可用分期付款计划。返回每月分期金额、利息和费用。通常用于产品页面。 |
| 搜索API | searchSearchInvoicesProcessed | POST /api/v3/search/invoices/processed | 返回符合标准的发票。 |
模型文档
- 账户
- 账户产品
- 添加事件到账户请求
- 添加事件到账户响应
- 添加运输详情请求
- 添加运输详情响应
- 添加交易请求
- 添加交易响应
- 附加数据
- 附加交易信息
- 地址
- 航空公司
- 申请账户信用请求
- 申请账户信用响应
- 授权付款请求
- 授权付款响应
- 可用分期付款计划请求
- 可用分期付款计划响应
- 可用付款方式请求
- 可用付款方式响应
- 公共汽车
- 活动
- 活动信息
- 取消项目
- 取消
- 捕获
- 捕获项目
- 捕获请求
- 捕获响应
- 结账客户
- 合并发票
- 合同
- 创建合同请求
- 创建合同响应
- 创建用户请求
- 创建用户响应
- 客户
- 客户查找请求
- 客户查找响应
- 客户响应
- 客户风险
- 删除运输详情响应
- 删除交易响应
- 直接借记
- 直接借记信息
- 事件项目
- 渡轮
- 获取所有捕获响应
- 获取所有退款响应
- 获取所有运输详情响应
- 获取订单响应
- 获取剩余额度响应
- 获取状态响应
- 获取版本响应
- 获取已取消响应
- 酒店
- 分期付款
- 分期付款信息
- 保险
- 发票
- 行程单
- 交易列表响应
- 通过SSN查找账户响应
- 查找地址
- 标记已处理发票请求
- 标记已处理发票响应
- 市场
- Ok结果
- 订单
- 订单项
- 订单项扩展
- 订单风险
- 订单摘要
- 停车场客户
- 合作伙伴数据
- 乘客
- 支付
- 支付方式
- 参考资料
- 退款
- 退款项
- 退款订单项
- 退款订单请求
- 退款订单响应
- 租赁
- 响应消息
- 响应订单详情
- 运输详情
- 带编号的运输详情
- 订阅
- 火车
- 交易
- 更新运输详情请求
- 更新运输详情响应
- 用户资料
- 验证地址请求
- 验证地址响应
- 验证银行账户请求
- 验证银行账户响应
- 取消授权请求
- 取消授权响应
授权文档
apiKey
- 类型: API密钥
- API密钥参数名: X-Auth-Key
- 位置: HTTP头