指南
状态页面Dashboard预约演示
开始键入搜索...

NuPay

本指南使用 Direct 工作流程探讨 Yuno 的 NuPay 集成。您将学会如何

  • 将 NuPay 注册为客户付款方式
  • 分期付款（付款条件）
  • 设置订阅

要求

在开始之前，您需要

  • 可访问控制面板的 Yuno 账户
  • 应用程序接口密钥和 account_id （在仪表板中找到）
  • 在 Yuno 中创建的客户（或在步骤 1 中创建的客户）

创建和管理客户

使用您的外部设备创建一次客户 merchant_customer_id然后由 Yuno 检索 id 或由 merchant_customer_id 根据需要。

  1. 使用 创建客户 endpoint ，并提供自己的 merchant_customer_id (客户在系统中的唯一 ID）。响应返回 id 是 Yuno 的客户 ID。
  2. 使用 检索客户 与 Yuno id.
  3. 使用 按外部 ID 检索客户 查询参数 merchant_customer_id.

注册 NuPay 支付方式

请按照以下步骤注册 NU_PAY_ENROLLMENT 使用直接工作流程向客户发送。

步骤 1：创建客户

如果还没有客户，请按上图创建一个。您将使用返回的客户 id.

步骤 2：注册付款方式

使用带有以下请求参数的 "注册付款方式"：

  • 类型: NU_PAY_ENROLLMENT
  • account_id:您账户的 UUID（来自 Yuno 控制面板）
  • 工作流程: DIRECT

预期回复字段：

  • 金库令牌：注册支付方式的 UUID
  • 地位: READY_TO_ENROLL
  • 子状态: WAITING_ADDITIONAL_STEP
  • 行动: REDIRECT_URL
  • redirect_url：将客户重定向至 Nu 以进行身份验证的 URL

步骤 3：重新引导客户

将客户重定向到 redirect_url.客户完成 Nu 流程。Nu 将最终状态通知 Yuno。

步骤 4：确认注册

使用 按 ID 检索已注册的付款方式 与 vaulted_token.成功注册后返回：

  • 地位: ENROLLED
  • 子状态: ENROLLED
⚠️

只有在 Yuno 收到 Nu 的确认后，注册才算完成。

附带付款条件的付款（分期付款）

注册后，您可以使用 NuPay 付款条件接受付款。

步骤 1：确保先决条件

有一位 Yuno 客户 id 和注册的 NuPay vaulted_token.

步骤 2：获取付款条件

使用 APM 分期付款endpoint申请 NuPay 可用的分期付款选项。

curl --location 'https://api-sandbox.y.uno/v1/apm-installments' \
--header 'public-api-key: {{your_public_api_key}}' \
--header 'private-secret-key: {{your_secret_api_key}}' \
--header 'X-account-code: {{your_account_code}}' \
--header 'Content-Type: application/json' \
--data '{
  "country": "BR",
  "amount": {
    "currency": "BRL",
    "value": "250"
  },
  "customer": {
    "id": "{{customer_id}}"
  },
  "payment_method": "NU_PAY_ENROLLMENT",
  "vaulted_token": "{{vaulted_token}}"
}'

响应会返回一个分期付款计划数组，包括 id可用 installments和金额。选择计划 id 以及允许的分期付款次数。

步骤 3：创建付款

使用 创建payment 直接工作流程和 NuPay 类型。将所选计划 ID 和分期付款包含在钱包中 card_data.

{
  "description": "test",
  "account_id": "{{account_id}}",
  "merchant_order_id": "0000023",
  "country": "BR",
  "merchant_reference": "ref-merchant-AA01",
  "amount": {
    "currency": "BRL",
    "value": 250
  },
  "customer_payer": {
    "id": "{{customer_id}}"
  },
  "workflow": "DIRECT",
  "callback_url": "https://your-callback.com",
  "payment_method": {
    "type": "NU_PAY_ENROLLMENT",
    "vaulted_token": "{{vaulted_token}}",
    "detail": {
      "wallet": {
        "card_data": {
          "installments_plan_id": "{{plan_id}}",
          "installments": 2
        }
      }
    }
  }
}

步骤 4：取回付款

使用 "按 ID 检索付款 "确认最终状态。

订阅流程

您可以使用 NuPay 支付经常性费用。

  1. 创建客户
  2. 将 NuPay 注册为付款方式（见上文）
  3. 创建已注册的订阅 vaulted_token 使用 创建订阅
  4. 使用 "检索订阅 "功能检索订阅
⚠️

局限性

  • NuPay 订阅不支持付款条件（分期付款）
  • 不支持在付款申请中直接创建订阅

Endpoints

3 个月前已更新