trollweb/afterpay-api

为 https://developer.afterpay.io/api 生成的 Swagger API 库

2.1.1 2020-09-23 10:30 UTC

This package is auto-updated.

Last update: 2024-09-11 01:51:00 UTC


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 请求描述
CheckoutApicheckoutAuthorizePaymentPOST /api/v3/checkout/authorize批准特定客户和购物车的支付。主要用例为一步和两步授权。应用全面的欺诈和信用评分。如果在线商店客户输入错误地址数据,系统将提供修正地址的建议。
CheckoutApicheckoutAvailablePaymentMethodsPOST /api/v3/checkout/payment-methods返回指定购物车价值和客户端可用的优惠的可用支付方式。返回月供金额、利息和费用。发送客户数据和购物车内容以增强结果是可选的。如果在线商店客户输入错误的地址数据,系统将提供修正地址的建议。主要用例为两步授权。
CheckoutApicheckoutCreateContractPOST /api/v3/checkout/{checkoutId}/contract创建可向客户显示的分期付款和/或直接借记合同。
CommonApicommonCustomerLookupPOST /api/v3/lookup/customer根据社会保险号码或手机号码返回客户的地址。
CommonApicommonGetStatusGET /api/v3/status获取服务的状态
CommonApicommonGetVersionGET /api/v3/version获取服务的版本
CommonApicommonValidateAddressPOST /api/v3/validate/address检查交付的客户地址以及重复地址的音译和关联识别。此外,还可以处理特定于客户端的负面或正面列表的检查。通常,地址检查用于纯粹验证地址数据,例如用于注册流程。
CommonApicommonValidateBankAccountPOST /api/v3/validate/bank-account在直接借记支付的情况下验证和评估账户和银行详情。可以传输银行代码和账户号码的组合或 IBAN 和 BIC。
CustomerAccountApicustomerAccountAddEventPOST /api/v3/customer-account/{accountNumber}/event向账户添加事件
CustomerAccountApicustomerAccountAddTransactionPOST /api/v3/customer-account/{accountNumber}/transaction向账户添加交易
CustomerAccountApicustomerAccountApplyForCreditPOST /api/v3/customer-account申请客户账户信用
CustomerAccountApicustomerAccountCreateUserPOST /api/v3/customer-account/{accountNumber}/user将用户添加到账户
CustomerAccountApicustomerAccountCreditLimitGET /api/v3/customer-account/{accountNumber}/credit-limit获取账户剩余信用额度
CustomerAccountApicustomerAccountDeleteTransactionDELETE /api/v3/customer-account/{accountNumber}/transaction/{transactionId}取消账户的交易
CustomerAccountApicustomerAccountLookupBySSNGET /api/v3/customer-account/{ssn}通过SSN(社会保险号)查找客户账户
订单管理APIorderManagementAddShippingDetailsPOST /api/v3/orders/{orderNumber}/captures/{captureNumber}/shipping-details将新的运输详情信息添加到捕获。
订单管理APIorderManagementCapturePOST /api/v3/orders/{orderNumber}/captures完成已授权的付款。通常在订单发货时进行。可以是订单金额的全部或部分捕获。
订单管理APIorderManagementDeleteShippingDetailsDELETE /api/v3/orders/{orderNumber}/captures/{captureNumber}/shipping-details/{shippingNumber}从特定捕获中删除运输详情信息。
订单管理APIorderManagementGetCaptureGET /api/v3/orders/{orderNumber}/captures/{captureNumber}返回订单的所有或特定捕获付款。
订单管理APIorderManagementGetOrderGET /api/v3/orders/{orderNumber}返回指定订单的内容。
订单管理APIorderManagementGetRefundGET /api/v3/orders/{orderNumber}/refunds/{refundNumber}返回订单的所有或特定退款。
订单管理APIorderManagementGetShippingDetailsGET /api/v3/orders/{orderNumber}/captures/{captureNumber}/shipping-details/{shippingNumber}返回捕获的所有或特定运输详情信息。
订单管理APIorderManagementGetVoidGET /api/v3/orders/{orderNumber}/voids/{voidNumber}返回订单的所有或特定已取消(已撤销)的授权。
订单管理APIorderManagementRefundPOST /api/v3/orders/{orderNumber}/refunds部分或全额退款已捕获的付款。
订单管理APIorderManagementUpdateShippingDetailsPATCH /api/v3/orders/{orderNumber}/captures/{captureNumber}/shipping-details/{shippingNumber}更新特定捕获的运输详情信息。
订单管理APIorderManagementVoidPOST /api/v3/orders/{orderNumber}/voids取消(撤销)未捕获的授权。
产品APIproductAvailableInstallmentPlansPOST /api/v3/lookup/installment-plans返回特定产品/购物车价值的可用分期付款计划。返回每月分期金额、利息和费用。通常用于产品页面。
搜索APIsearchSearchInvoicesProcessedPOST /api/v3/search/invoices/processed返回符合标准的发票。

模型文档

授权文档

apiKey

  • 类型: API密钥
  • API密钥参数名: X-Auth-Key
  • 位置: HTTP头

作者