jbl/coe-mollie-api-php

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

维护者

详细信息

github.com/Gainto/coe-mollie-api-php

主页

源代码

安装: 4

依赖项: 0

建议者: 0

安全: 0

星标: 0

关注者: 0

分支: 190

2.70.0 2024-07-04 13:49 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 f475cad984cc042a820334d572c811564addff57

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

apipaymentpaymentsservicegatewaypaypalidealmolliepaysafecardseparecurringsubscriptionscreditcardsofortdirect debitmistercashklarnabancontactsofortbankingchargesCBCbanktransferbelfiusbelfius direct netrefundsPrzelewy24podiumcadeaukaartkbcApple Paygift cardsintersolvefashionchequeinghomepaypaylatersliceit

This package is auto-updated.

Last update: 2024-09-04 14:09:53 UTC

README

PHP的Mollie API客户端

mollie-api-php-header

接受以下支付方式：iDEAL、Apple Pay、Bancontact、SOFORT Banking、信用卡、SEPA银行转账、SEPA直接借记、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起，现在可以为您的客户创建非欧元支付。您可以在我们的文档中找到可用的完整货币列表：这里。

$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检索支付并检查支付是否已支付。

$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请求。但是，如果您对参与技术导向的组织感兴趣，Mollie正在积极招聘开发人员和系统工程师。了解我们当前的职位空缺或联系我们。

许可证

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

支持

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