README

该包存在是因为需要将第三方项目与 pagar.me 进行集成。该 SDK 开发者与 pagar.me 公司之间没有任何联系

安装

您可以通过 composer 安装此包。

composer require danielsmelo/pagarme

您可以使用以下命令发布配置文件：

php artisan vendor:publish --tag="pagarme-config"

以下是发布配置文件的内容：

return [
    'api_key'     => 'sua_api_key',
    'base_url'    => 'https://api.pagar.me/core',
    'api_version' => 'v5',
];

使用方法

每个函数对应于 pagar.me 提供的 API 端点（https://api.pagar.me/core/v5）。

客户

路由：POST /customers

函数

Pagarme::client()->create(array $data)

描述：根据提供的数据创建新客户。

路由：GET /customers/{id}

函数

Pagarme::client()->find(string $id)

描述：根据 ID 获取特定客户的信息。

路由：PUT /customers/{id}

函数

Pagarme::client()->update(string $id, array $data)

描述：根据 ID 和新的数据更新特定客户的信息。

路由：GET /customers

函数

Pagarme::client()->all()

描述：获取所有已注册客户列表。

路由：POST /customers/{id}/cards

函数

Pagarme::client()->createCreditCard(string $id, array $data)

描述：根据 ID 和卡片数据创建与特定客户关联的新信用卡。

路由：GET /customers/{id}/cards/{cardId}

函数

Pagarme::client()->findCreditCard(string $id, string $cardId)

描述：根据客户 ID 和卡片 ID 获取特定信用卡的信息。

路由：GET /customers/{id}/cards

函数

Pagarme::client()->allCreditCards(string $id)

描述：根据客户 ID 获取与特定客户关联的所有信用卡列表。

路由：PUT /customers/{id}/cards/{cardId}

函数

Pagarme::client()->updateCreditCard(string $id, $cardId, array $data)

描述：根据客户 ID、卡片 ID 和新的数据更新与特定客户关联的信用卡信息。

路由：DELETE /customers/{id}/cards/{cardId}

函数

Pagarme::client()->deleteCreditCard(string $id, string $cardId)

描述：根据客户 ID 和卡片 ID 删除与特定客户关联的信用卡。

路由：POST /customers/{id}/cards/{cardId}/renew

函数

Pagarme::client()->renewCreditCard(string $id, string $cardId)

描述：根据客户 ID 和卡片 ID 更新与特定客户关联的信用卡。

路由：POST /customers/{id}/addresses

函数

Pagarme::client()->createAddress(string $id, array $data)

描述：根据提供的 ID 和地址数据创建与特定客户关联的新地址。

路由：GET /customers/{id}/addresses/{addressId}

函数

Pagarme::client()->findAddress(string $id, string $addressId)

描述：根据客户 ID 和地址 ID 获取特定地址的信息。

路由：GET /customers/{id}/addresses

函数

Pagarme::client()->allAddresses(string $id)

描述：根据客户 ID 获取与特定客户关联的所有地址列表。

路由：PUT /customers/{id}/addresses/{addressId}

函数

Pagarme::client()->updateAddress(string $id, $addressId, array $data)

描述：根据客户 ID、地址 ID 和新的数据更新与特定客户关联的地址信息。

路由：DELETE /customers/{id}/addresses/{addressId}

函数

Pagarme::client()->deleteAddress(string $id, string $addressId)

描述：根据客户 ID 和地址 ID 删除与特定客户关联的地址。

收费

路由：POST /charges/{id}/capture

函数

Pagarme:charge()->capture(string $id, array $data)

描述：根据收费 ID 和提供的数据捕获与特定收费关联的待处理付款。

路由：POST /charges

函数

Pagarme:charge()->create(array $data)

描述：根据提供的数据创建新收费。

路由：GET /charges/{id}

函数

Pagarme:charge()->find(string $id)

描述：根据 ID 获取特定收费的信息。

路由：PUT /charges/{id}/card

函数

Pagarme:charge()->editCard(string $id, array $data)

描述：根据账单ID和新提供的数据，编辑特定账单关联的卡片信息。

路由：PUT /charges/{id}/due-date

函数

Pagarme:charge()->dueDate(string $id, array $data)

描述：根据账单ID和新到期日期，更新特定账单的到期日期。

路由：PUT /charges/{id}/payment-method

函数

Pagarme:charge()->updatePaymentMethod(string $id, array $data)

描述：根据账单ID和新支付方式数据，更新特定账单关联的支付方式。

路由：DELETE /charges/{id}

函数

Pagarme:charge()->cancel(string $id)

描述：根据ID取消特定账单。

路由：GET /charges

函数

Pagarme:charge()->all()

描述：获取所有账单的列表。

路由：POST /charges/{id}/retry

函数

Pagarme:charge()->retry(string $id)

描述：基于账单ID，尝试再次为之前失败的特定账单进行支付。

路由：POST /charges/{id}/confirm-payment

函数

Pagarme:charge()->confirmCash(string $id, array $data)

描述：基于账单ID和提供的数据，确认与特定账单关联的现金支付。

订单

路由：POST /orders

函数

Pagarme:order()->create(array $data)

描述：根据提供的数据创建新的订单。

路由：GET /orders/{id}

函数

Pagarme:order()->find(string $id)

描述：根据ID获取特定订单的信息。

路由：POST /orders/{id}/closed

函数

Pagarme:order()->close(string $id)

描述：根据ID关闭特定订单。

路由：GET /orders

函数

Pagarme:order()->all()

描述：获取所有订单的列表。

路由：POST /orders/{id}/items

函数

Pagarme:order()->addItem(string $id, array $data)

描述：根据提供的订单ID和项目数据，向特定订单添加新项目。

路由：PUT /orders/{id}/items/{itemId}

函数

Pagarme:order()->updateItem(string $id, string $itemId, array $data)

描述：根据订单和项目ID，以及提供的新数据，更新与订单关联的特定项目信息。

路由：DELETE /orders/{id}/items/{itemId}

函数

Pagarme:order()->deleteItem(string $id, string $itemId)

描述：根据订单和项目ID，删除与订单关联的特定项目。

路由：DELETE /orders/{id}/items

函数

Pagarme:order()->deleteAllItems(string $id)

描述：根据订单ID，删除与特定订单关联的所有项目。

路由：GET /orders/{id}/items

函数

Pagarme:order()->allItems(string $id)

描述：根据订单ID，获取与特定订单关联的所有项目的列表。

收件人

路由：POST /recipients

函数

Pagarme:recipent()->create(array $data)

描述：根据提供的数据创建新的收件人。

路由：GET /recipients/{id}

函数

Pagarme:recipent()->find(string $id)

描述：根据ID获取特定收件人的信息。

路由：PUT /recipients/{id}

函数

Pagarme:recipent()->update(string $id, array $data)

描述：根据ID和提供的新数据更新特定收件人的信息。

路由：GET /recipients

函数

Pagarme:recipent()->all()

描述：获取所有收件人的列表。

变更日志

请参阅变更日志获取最近更改的更多信息。

致谢

• Daniel Melo

许可证

许可证 MIT (MIT)。请参阅许可证文件获取更多信息。