line-pay-merchant

LINE Pay V3 Online APIs library for Node.js

Quick Start

npm install line-pay-merchant

Basic Example

Request:

import { createLinePayClient } from 'line-pay-merchant'

const linePayClient = createLinePayClient({
  channelId: '1479113123',
  channelSecretKey: '1f021e50f28fb3f40b7a9c5e758b0a19',
  env: 'development' // env can be 'development' or 'production'
})

try {
  const res = await linePayClient.request.send({
    body: {
      amount: 1000,
      currency: 'TWD',
      orderId: '20211216003',
      packages: [
        {
          id: 'c99abc79-3b29-4f40-8851-bc618ca57856',
          amount: 1000,
          products: [
            {
              name: 'Product Name',
              quantity: 2,
              price: 500
            }
          ]
        }
      ],
      redirectUrls: {
        confirmUrl: 'https://myshop.com/confirmUrl',
        cancelUrl: 'https://myshop.com/cancelUrl'
      }
    }
  })

  console.log(res)
} catch (e) {
  console.log('error', e)
}

Response:

{
  "body": {
    "returnCode": "0000",
    "returnMessage": "Success.",
    "info": {
      "paymentUrl": {
        "web": "https://sandbox-web-pay.line.me/web/payment/wait?transactionReserveId=eVBISG5rQ09QL2JBVmJsdGdGN3RiUlBLaU0vMUtKWGEvVzhZS3o5NnBvSUlqZXdLdXk3Wlh0RXY2a0o3ZHp6Yw",
        "app": "line://pay/payment/eVBISG5rQ09QL2JBVmJsdGdGN3RiUlBLaU0vMUtKWGEvVzhZS3o5NnBvSUlqZXdLdXk3Wlh0RXY2a0o3ZHp6Yw"
      },
      "transactionId": "2021121600698709710",
      "paymentAccessToken": "656097936065"
    }
  },
  "comments": {}
}

Table of Contents

• Features
• Guide
• Documentation
• Error Handling
  • Error
• Resources

Features

• Auto-generated LINE Pay API V3 authentication header
• Built-in API request and response handler
• Fully customizable API request and response handler
• TypeScript support
• Handles transaction ID parsing (see Transaction ID)

Guide

Please visit Guide for more details.

Documentation

Please visit LINE Pay Merchant for more details.

Error Handling

Error

• FormatError: Request format incorrect
• HttpError: HTTP error (ex. 400, 403, 404, 500)
• TimeoutError: HTTP request timeout.
• LinePayError: LINE Pay API returns non-0000 return code.

Resources

• LINE Pay Online APIs