节点的 Adyen API 库

这是我们建议与Adyen APIs整合的Node.js的官方Adyen API库.

支持的 APIs

该库支持以下内容:

支持的 Webhook 版本

库支持以下模式目录下的所有webhooks:

更多信息请参见我们 文档 或 API 浏览器。 。 。 .

在你开始之前

在开始整合之前:

• 创建 Adyen 测试账户。 。 。 .
• 设置您的 API 证书。 。 。 .
• 安装节点.js 18版或稍后版本.

安装

安装 节点JS软件包数字 :

npm install --save @adyen/api-library

也可以下载 在 GitHub 上发布。 。 。 .

更新

要更新Node.JS软件包:

npm update @adyen/api-library

检查断开更改 页 次。 。 。 .

使用量

// Step 1: Require the parts of the module you want to use
const { Client, CheckoutAPI, EnvironmentEnum} = require('@adyen/api-library');

// Step 2: Initialize the client object
const client = new Client({apiKey: "YOUR_API_KEY", environment: EnvironmentEnum.TEST}); 

// Step 3: Initialize the API object
const checkoutApi = new CheckoutAPI(client);

// Step 4: Create the request object
  const paymentRequest = {
    amount: {
      currency: "USD",
      value: 1000 // value in minor units
    },
    reference: "Your order number",
    paymentMethod: {
      type: "scheme",
      encryptedCardNumber: "test_4111111111111111",
      encryptedExpiryMonth: "test_03",
      encryptedExpiryYear: "test_2030",
      encryptedSecurityCode: "test_737"
    },
    shopperReference: "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
    storePaymentMethod: true,
    shopperInteraction: "Ecommerce",
    recurringProcessingModel: "CardOnFile",
    returnUrl: "https://your-company.com/...",
    merchantAccount: "YOUR_MERCHANT_ACCOUNT"
  };
  
// Step 5: Make the request
checkoutApi.PaymentsApi.payments(paymentRequest)
  .then(paymentResponse => console.log(paymentResponse.pspReference))
  .catch(error => console.log(error));

如果您想要通过查询字符串参数, 您可以使用 params 从字段 我请求 (也用于一能键和其他头字段). 方法描述包含一个实例,说明您可以发送到API用于查询参数的可能值,就像API 探索器中所说的.

您也可以在请求中使用自定义 HTTP 头 headers 内部的属性 IRequest.Options。这可用于发送不属于标准API请求正文或查询参数的其他元数据或认证细节.

const requestOptions: IRequest.Options = {
    headers: {
        "X-Custom-Header": "MyValue",
        "Another-Custom-Header": "AnotherValue"
    }
};
checkoutApi.PaymentsApi.payments(paymentRequest, requestOptions)
  .then(response => console.log("Payment successful:", response))
  .catch(error => console.error("Payment failed:", error));

const requestOptions: IRequest.Options = {
    params: {
        limit: "5",
        offset: "10"
    }
};
await balancePlatformService.AccountHoldersApi.getAllBalanceAccountsOfAccountHolder("AH32272223222B5CM4MWJ892H", requestOptions);

第1步: 需要您想要使用的模块部分

使用节点.js require 函数以装入 Client 和 Adyen 模块中的 API 对象。 API 对象的名称见 支持的 APIs。 。 。 .

例如,使用 检查出 API数字 :

const { Client, CheckoutAPI, EnvironmentEnum} = require('@adyen/api-library');

步骤2: 初始化客户端对象

初始化客户端对象,通过如下:

• apiKeyAPI 键入您 从客户区生成。 。 。 .
• environment: 对于试验环境,使用 测试对于活的环境,使用 活着。 。 。 .

例如:

const client = new Client({apiKey: "YOUR_API_KEY", environment: EnvironmentEnum.TEST}); 

第3步: 初始化 API 对象

初始化您想要使用的 API 对象,通过 client 对象来自上一个步骤.

举例来说 检查出 API数字 :

const checkoutApi = new CheckoutAPI(client);

步骤 4: 创建请求对象

创建请求对象 。 例如,对于请求 /payments 结束点 :

  const paymentRequest = {
    amount: {
      currency: "USD",
      value: 1000 // value in minor units
    },
    reference: "Your order number",
    paymentMethod: {
      type: "scheme",
      encryptedCardNumber: "test_4111111111111111",
      encryptedExpiryMonth: "test_03",
      encryptedExpiryYear: "test_2030",
      encryptedSecurityCode: "test_737"
    },
    shopperReference: "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
    storePaymentMethod: true,
    shopperInteraction: "Ecommerce",
    recurringProcessingModel: "CardOnFile",
    returnUrl: "https://your-company.com/...",
    merchantAccount: "YOUR_MERCHANT_ACCOUNT"
  };

步骤5:提出请求

使用 API 对象的方法来进行请求. 例如,要求 /payments 使用 CheckoutAPI 对象 :

checkoutApi.PaymentsApi.payments(paymentRequest)
  .then(paymentResponse => console.log(paymentResponse.pspReference))
  .catch(error => console.log(error));

启用时的客户端设置

对于APIS,需要你 现场 URL 前缀 客户端(Binookup,平衡控制,取出,支付和经常性)的设置如下,以便开始处理活期支付: 1

const { Client, EnvironmentEnum } = require('@adyen/api-library');

const client = new Client({apiKey: "YOUR_API_KEY", environment: EnvironmentEnum.LIVE, liveEndpointUrlPrefix: "YOUR_LIVE_URL_PREFIX"}); 

类型脚本中使用

或者,你可以使用 Types 包含在本模块中的 Typescript和 async 语法.

  const { Client, EnvironmentEnum, CheckoutAPI, Types } = require('@adyen/api-library');
  const client = new Client({apiKey: "YOUR_API_KEY", environment: EnvironmentEnum.LIVE, liveEndpointUrlPrefix: "YOUR_LIVE_URL_PREFIX"});

  const makePaymentsRequest = async () => {
    const paymentsRequest : Types.checkout.PaymentRequest = {
      amount: {
        currency: "USD",
        value: 1000 // Value in minor units.
      },
      reference: "Your order number",
      paymentMethod: {
        type: Types.checkout.CardDetails.TypeEnum.Scheme,
        encryptedCardNumber: "test_4111111111111111",
        encryptedExpiryMonth: "test_03",
        encryptedExpiryYear: "test_2030",
        encryptedSecurityCode: "test_737"
      },
      shopperReference: "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
      storePaymentMethod: true,
      shopperInteraction: Types.checkout.PaymentRequest.ShopperInteractionEnum.Ecommerce,
      recurringProcessingModel: Types.checkout.PaymentRequest.RecurringProcessingModelEnum.CardOnFile,
      returnUrl: "https://your-company.com/...",
      merchantAccount: "YOUR_MERCHANT_ACCOUNT"
    };
    const checkoutAPI = new CheckoutAPI(client);
    const paymentResponse : Types.checkout.PaymentResponse = await checkoutAPI.PaymentsApi.payments(paymentsRequest);
    console.log(paymentResponse.pspReference);
  }

  makePaymentsRequest();

切换 JSON 字符串

在一些设置中,你可能需要去序列化JSON字符串来请求对象. 例如,在结合使用图书馆时 投篮/组件。请使用内置去区域化功能:

// Import the models
import { Types } from "@adyen/api-library";

// Deserialize using built-in ObjectSerializer class
const requestJson: JSON = JSON.parse(`YOUR_JSON_STRING`);
const paymentRequest: Types.checkout.PaymentRequest = await Types.checkout.ObjectSerializer.deserialize(requestJson,"PaymentRequest");

自定义 HTTP 客户端配置

默认, 节点.js https 用于提出 API 请求。 也可以设置自定义 HttpClient 送给你的 Client 对象.

说明: 当使用您的自定义时 HttpClient,您必须定义所有需要的属性(API密钥、内容类型、超时等)

例如,设置 axios 作为您的 HTTP 客户端 :

const {Client, Config} = require('@adyen/api-library');
const axios = require("axios");
// ... more code
const config = new Config();
const client = new Client({
  config,
  httpClient: {
    async request(endpoint, json, config, isApiKeyRequired, requestOptions) {
        const response = await axios({
            method: 'POST',
            url: endpoint,
            data: JSON.parse(json),
            headers: {
                "X-API-Key": config.apiKey,
                "Content-type": "application/json"
            },
        });

        return response.data;
    }
  }
});
// ... more code

浏览和认证银行网站

(一) 分析账户记录通知要求网页浏览;

// import models
import { Types, ConfigurationWebhooksHandler } from "@adyen/api-library";

const configurationWebhooksHandler = new ConfigurationWebhooksHandler(YOUR_BANKING_WEBHOOK);
const accountHolderNotificationRequest: Types.configurationWebhooks.AccountHolderNotificationRequest = configurationWebhooksHandler.getAccountHolderNotificationRequest();

也可以使用通用类型解析webhook,以防您事先不知道webhook类型. 在这种情况下,您可以检查webhook的实例,以便将其分析为相应的类型(或只是动态使用);

const configurationWebhooksHandler = new ConfigurationWebhooksHandler(YOUR_BANKING_WEBHOOK);
const genericWebhook = configurationWebhooksHandler.getGenericWebhook();

if ("accountHolderCode" in genericWebhook) {
  console.log("This is an AccountHolderNotificationRequest");
} else if ("balanceAccountId" in genericWebhook) {
  console.log("This is a BalanceAccountNotificationRequest");
}

校验真实性(从 CA 取出 hmac 密钥和从 Webhook 信头取出签名);

import { hmacValidator } from "@adyen/api-library";

const validator = new hmacValidator();
const isValid = validator.validateHMACSignature("YOUR_HMAC_KEY", "YOUR_HMAC_SIGNATURE", jsonString);

管理 Webhooks

管理网点也用同样的方法解析,使用 ManagementWebhooksHandler数字 :

const managementWebhooksHandler = new ManagementWebhooksHandler(YOUR_MANAGEMENT_WEBHOOK);
const genericWebhook = managementWebhooksHandler.getGenericWebhook();

代理配置

要配置代理连接,请设置 proxy 您的财产 HttpURLConnectionClient 对象.

例如:

const {HttpURLConnectionClient, Client, Config, EnvironmentEnum} = require('@adyen/api-library');
// ... more code
const client = new Client({apiKey: "YOUR_API_KEY", environment: EnvironmentEnum.TEST}); 
const httpClient = new HttpURLConnectionClient();
httpClient.proxy = { host: "http://google.com", port: 8888,  };

client.httpClient = httpClient;

// ... more code

亲自支付整合

构建内容丰富的特性 亲自付款 整合,以全球和地方支付方式接受世界各地的支付,并为您的客户创造出独特的购物体验.

使用 Cloud 设备 API

对于内部支付云集,建议的解决办法是: 云设备 API。 。 。 .

检查 云设备 API 读取。 。 。 .

如果您正在使用终端( Cloud) API, 请参见 移徙指南。 。 。 .

使用终端 API

与 终端 API 您可以以下列方式发送和接收终端 API 消息:

• 本地通信:使用您本地网络,您的POS系统将请求直接发送到终端的IP地址,并同步接收结果.
• 云通信:使用互联网访问云 /sync 财务报告和审定财务报表 /async 结束点。 考虑通过 云设备 API 换句话说.

检查 终端API 读取器。 。 。 .

反馈

我们珍视你的投入! 帮助我们加强API图书馆,并通过提供反馈来改善整合经验. 请花点时间填一下 我们的反馈表 分享你的想法、建议或想法.

实例整合

克隆我们的 节点集成 以查看如何使用用于Node.js的 Adyen API 库。 集成内容包括强调关键特征和概念的代码注释.

捐款

我们强烈鼓励你通过以下方式为这个存放处作出贡献:

• 新增功能和功能.
• 修复错误和问题.
• 总体改进.

为了学习如何创建拉动请求,读读我们 捐款准则。 。 。 .

支助

请求特性、报告错误或报告安全弱点, 创建 GitHub 问题。 。 。 .

有其它问题请联系我们 支助小组。 。 。 .

许可证

此寄存器可在 麻省理工学院许可证。 。 。 .

另见

• 实例整合