coe/mollie-api-php

Mollie API 客户端库用于 PHP。Mollie 是一家欧洲支付服务提供商，提供国际支付方式，如 Mastercard、VISA、美国运通和 PayPal，以及本地支付方式，如 iDEAL、Bancontact、SOFORT Banking、SEPA 直接借记、Belfius Direct Net、KBC Payment But

维护者

详细信息

github.com/codeenterprise/mollie-api-php

主页

源代码

安装: 6

依赖者: 0

建议者: 0

安全: 0

星级: 0

关注者: 0

分支: 189

2.70.0 2024-08-19 18:39 UTC

Requires

Requires (Dev)

Suggests

  • mollie/oauth2-mollie-php: Use OAuth to authenticate with the Mollie API. This is needed for some endpoints. Visit https://docs.mollie.com/ for more information.

BSD-2-Clause 2f32e3ed78d5060a35ffb444003e9872bf0cbc8a

  • Mollie B.V. <info.woop@mollie.com>

apipaymentpaymentsservicegatewaypaypalidealmolliepaysafecardseparecurringsubscriptionscreditcardsofortdirect debitmistercashklarnabancontactsofortbankingchargesCBCbanktransferbelfiusbelfius direct netrefundsPrzelewy24podiumcadeaukaartkbcApple Paygift cardsintersolvefashionchequeinghomepaypaylatersliceit

This package is not auto-updated.

Last update: 2024-10-01 17:18:13 UTC

README

PHP Mollie API 客户端

mollie-api-php-header

接受 iDEAL、Apple Pay、Bancontact、SOFORT Banking、Creditcard、SEPA Bank transfer、SEPA Direct debit、PayPal、Belfius Direct Net、KBC/CBC、paysafecard、ING Home'Pay、Giropay、EPS、Przelewy24、Postepay、In3、Klarna（《立即支付》、《延迟支付》、《分期付款》、《3期付款》），礼品卡 和 优惠券 在线支付，无需固定的月费或任何惩罚性注册流程。只需使用 Mollie API 就可以直接在您的网站上接收支付或轻松为客户退款。

Build Status Latest Stable Version Total Downloads

要求

要使用 Mollie API 客户端，需要以下事项

  • 免费注册一个 Mollie 账户。无需注册费用。
  • 现在您已经准备好以测试模式使用 Mollie API 客户端。
  • 按照 几个步骤 启用实时模式下的支付方式，其余的交给我们处理。
  • PHP >= 7.2
  • 最新的 OpenSSL（或其他 SSL/TLS 工具包）

为了利用 Mollie Connect（仅限高级用例），我们建议还安装我们的 OAuth2 客户端。

安装

使用 Composer

安装 Mollie API 客户端最简单的方法是使用 Composer。您可以使用以下命令进行要求

composer require mollie/mollie-api-php

要使用最新的API版本，请确保您使用的API客户端版本等于或高于2.0.0。如果您想继续使用v1 API，请确保您的客户端版本低于2.0.0。有关从v1迁移到v2的指导，请参阅迁移说明。

手动安装

如果您不熟悉使用composer，我们已在发布中添加了一个包含API客户端和通常由composer安装的所有包的ZIP文件。从发布页面下载mollie-api-php.zip。

如初始化示例所示，包含vendor/autoload.php。

用法

初始化Mollie API客户端，并设置您的API密钥。

$mollie = new \Mollie\Api\MollieApiClient();
$mollie->setApiKey("test_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM");

使用MollieApiClient，您现在可以通过选择客户端的属性来访问以下任何端点

在我们的网站上找到完整的文档docs.mollie.com。

订单

创建订单

创建订单引用

$order = $mollie->orders->create([
    "amount" => [
        "value" => "1027.99",
        "currency" => "EUR",
    ],
    "billingAddress" => [
        "streetAndNumber" => "Keizersgracht 313",
        "postalCode" => "1016 EE",
        "city" => "Amsterdam",
        "country" => "nl",
        "givenName" => "Luke",
        "familyName" => "Skywalker",
        "email" => "luke@skywalker.com",
    ],
    "shippingAddress" => [
        "streetAndNumber" => "Keizersgracht 313",
        "postalCode" => "1016 EE",
        "city" => "Amsterdam",
        "country" => "nl",
        "givenName" => "Luke",
        "familyName" => "Skywalker",
        "email" => "luke@skywalker.com",
    ],
    "metadata" => [
        "some" => "data",
    ],
    "consumerDateOfBirth" => "1958-01-31",
    "locale" => "en_US",
    "orderNumber" => "1234",
    "redirectUrl" => "https://your_domain.com/return?some_other_info=foo",
    "webhookUrl" => "https://your_domain.com/webhook",
    "method" => "ideal",
    "lines" => [
        [
            "sku" => "5702016116977",
            "name" => "LEGO 42083 Bugatti Chiron",
            "productUrl" => "https://shop.lego.com/nl-NL/Bugatti-Chiron-42083",
            "imageUrl" => 'https://sh-s7-live-s.legocdn.com/is/image//LEGO/42083_alt1?$main$',
            "quantity" => 2,
            "vatRate" => "21.00",
            "unitPrice" => [
                "currency" => "EUR",
                "value" => "399.00",
            ],
            "totalAmount" => [
                "currency" => "EUR",
                "value" => "698.00",
            ],
            "discountAmount" => [
                "currency" => "EUR",
                "value" => "100.00",
            ],
            "vatAmount" => [
                "currency" => "EUR",
                "value" => "121.14",
            ],
        ],
        // more order line items
    ],
]);

创建后，订单ID将可用在$order->id属性中。您应该将此ID与您的订单一起存储。

存储订单ID后，您可以使用$order->getCheckoutUrl()将客户发送到完成订单支付的页面。

header("Location: " . $order->getCheckoutUrl(), true, 303);

此头位置始终应为GET，因此我们强制执行303 http响应代码

有关创建订单的示例，请参阅示例 - 新订单。

更新订单

更新订单文档

$order = $mollie->orders->get("ord_kEn1PlbGa");
$order->billingAddress->organizationName = "Mollie B.V.";
$order->billingAddress->streetAndNumber = "Keizersgracht 126";
$order->billingAddress->city = "Amsterdam";
$order->billingAddress->region = "Noord-Holland";
$order->billingAddress->postalCode = "1234AB";
$order->billingAddress->country = "NL";
$order->billingAddress->title = "Dhr";
$order->billingAddress->givenName = "Piet";
$order->billingAddress->familyName = "Mondriaan";
$order->billingAddress->email = "piet@mondriaan.com";
$order->billingAddress->phone = "+31208202070";
$order->update();

退款订单

完成
$order = $mollie->orders->get('ord_8wmqcHMN4U');
$refund = $order->refundAll();

echo 'Refund ' . $refund->id . ' was created for order ' . $order->id;
部分

在执行部分退款时，必须列出所有应退回的订单行项目。

$order = $mollie->orders->get('ord_8wmqcHMN4U');
$refund = $order->refund([
    'lines' => [
        [
            'id' => 'odl_dgtxyl',
            'quantity' => 1,
        ],
    ],
    "description" => "Required quantity not in stock, refunding one photo book.",
]);

取消订单

取消订单文档

在取消订单时，在执行取消操作之前检查订单是否可取消至关重要。有关更多信息，请参阅可能的订单状态。

$order = $mollie->orders->get("ord_pbjz8x");

if ($order->isCancelable) {
    $canceledOrder = $order->cancel();
    echo "Your order " . $order->id . " has been canceled.";
} else {
    echo "Unable to cancel your order " . $order->id . ".";
}

订单webhook

当订单状态更改时，在创建订单期间指定的webhookUrl将被调用。您可以使用POST参数中的id来检查状态并采取适当的操作。有关更多详细信息，请参阅示例 - Webhook。

付款

付款接收流程

付款接收流程文档

为确保付款接收成功，您应遵循以下步骤

  1. 使用Mollie API客户端发起付款。指定所需的金额、货币、描述，以及可选的付款方式。定义一个唯一的重定向URL，将客户在完成付款后重定向到该URL至关重要。

  2. 付款完成后，我们的平台将立即向配置的webhook发起异步请求。这使得您可以检索付款详细信息，确保您确切知道何时开始处理客户的订单。

  3. 客户将被重定向到步骤（1）中的URL，并且他们应该很高兴地发现订单已付款，现在处于处理阶段。

创建付款

创建付款文档

$payment = $mollie->payments->create([
    "amount" => [
        "currency" => "EUR",
        "value" => "10.00"
    ],
    "description" => "My first API payment",
    "redirectUrl" => "https://webshop.example.org/order/12345/",
    "webhookUrl"  => "https://webshop.example.org/mollie-webhook/",
]);

创建后，付款ID将可用在$payment->id属性中。您应该将此ID与您的订单一起存储。

存储付款ID后，您可以使用$payment->getCheckoutUrl()将客户发送到结账页面。

header("Location: " . $payment->getCheckoutUrl(), true, 303);

此头位置始终应为GET，因此我们强制执行303 http响应代码

有关创建付款的示例，请参阅示例 - 新付款。

多货币

从API v2.0开始，现在可以为您的客户创建非EUR的付款。可以在我们的文档中找到可用的完整货币列表此处。

$payment = $mollie->payments->create([
    "amount" => [
        "currency" => "USD",
        "value" => "10.00"
    ],
    //...
]);

创建后，settlementAmount 将包含将结算到您账户中的欧元金额。

创建完全集成的 iDEAL 付款

要在您的网站上完全集成 iDEAL 付款，请遵循以下额外步骤

  1. 检索支持 iDEAL 的发行者（银行）列表。
$method = $mollie->methods->get(\Mollie\Api\Types\PaymentMethod::IDEAL, ["include" => "issuers"]);

使用 $method->issuers 列表让客户选择他们首选的发行者。

$method->issuers 将是一个对象列表。在 API 调用中使用该对象的 $id 属性，并使用 $name 属性向客户显示发行者。

  1. 使用所选发行者创建付款
$payment = $mollie->payments->create([
    "amount" => [
        "currency" => "EUR",
        "value" => "10.00"
    ],
    "description" => "My first API payment",
    "redirectUrl" => "https://webshop.example.org/order/12345/",
    "webhookUrl"  => "https://webshop.example.org/mollie-webhook/",
    "method"      => \Mollie\Api\Types\PaymentMethod::IDEAL,
    "issuer"      => $selectedIssuerId, // e.g. "ideal_INGBNL2A"
]);

$payment 对象的 _links 属性将包含一个具有 href 属性的 checkout 对象，该属性是一个指向所选发行者的在线银行环境的 URL。可以通过使用 $payment->getCheckoutUrl() 获取此 URL 的一种简短方式。

有关更深入的示例，请参阅 示例 - iDEAL 付款。

检索付款

检索付款文档

我们可以使用 $payment->id 来检索付款并检查付款是否已 isPaid。

$payment = $mollie->payments->get($payment->id);

if ($payment->isPaid())
{
    echo "Payment received.";
}

或检索付款集合。

$payments = $mollie->payments->page();

有关列出具有详细信息和状态的付款的详细示例，请参阅 示例 - 列出付款。

退款付款

退款付款文档

我们的 API 提供了对退款付款的支持。请注意，没有确认步骤，所有退款都是立即和最终的。退款适用于除 paysafecard 和礼品卡之外的所有付款方式。

$payment = $mollie->payments->get($payment->id);

// Refund € 2 of this payment
$refund = $payment->refund([
    "amount" => [
        "currency" => "EUR",
        "value" => "2.00"
    ]
]);

付款 webhook

当付款状态更改时，您在付款创建期间指定的 webhookUrl 将被调用。您可以使用 POST 参数中的 id 来检查状态并采取适当的操作。有关更多详细信息，请参阅 示例 - Webhook。

有关工作示例，请参阅 示例 - 退款付款。

启用调试模式

在故障排除时，访问 ApiException 中的提交请求非常有用。为了防止意外地将敏感请求数据暴露在本地应用程序日志中，调试功能最初是关闭的。

要启用调试并检查请求

/** @var $mollie \Mollie\Api\MollieApiClient */
$mollie->enableDebugging();

try {
    $mollie->payments->get('tr_12345678');
} catch (\Mollie\Api\Exceptions\ApiException $exception) {
    $request = $exception->getRequest();
}

如果您正在记录 ApiException 的实例，请求详细信息将包含在日志中。确保在这些日志中不保留任何敏感信息，并在调试完成后进行清理。

再次禁用调试

/** @var $mollie \Mollie\Api\MollieApiClient */
$mollie->disableDebugging();

请注意，调试仅在默认 Guzzle http 适配器（Guzzle6And7MollieHttpAdapter）使用时可用。

API 文档

要深入了解我们的 API，请探索 Mollie 开发者门户。我们的 API 文档可用英文。

为我们 API 客户端做出贡献

您想为我们 API 客户端做出贡献吗？我们欢迎 pull requests。但，如果您对参与技术导向的组织感兴趣，Mollie 正在积极招聘开发人员和系统工程师。了解我们的当前 职位空缺 或 联系。

许可证

BSD (伯克利软件发行版) 许可证。版权所有 (c) 2013-2018，Mollie B.V.

支持

联系方式： www.mollie.com — info@mollie.com — +31 20 820 20 70