Request API

Overview

An API to request payment information to LINE Pay. User can change settings such as order information or various payment methods. Once the request is successful, a transaction ID is generated and with the ID, you can complete the payment or process refund.

• send
• addHandler
• addHandlers

send

send(requestRequestConfig)

Returns Promise<ApiResponse<RequestResponseBody>>

Request Config

export type Package = {
  /**
   * An unique ID of package list
   */
  id: string
  /**
   * Total amount of products per package\
   * `=sum(products[].quantity * products[].price)`
   */
  amount: number
  /**
   * User fee: Respond if a commission is found within the payment amount.
   */
  userFee?: number
  /**
   * Name of the package or name of internal shops
   */
  name?: string
  /**
   * products in the package
   */
  products: Product[]
}

export type RedirectUrls = {
  /**
   * An information to prevent phishing while transferring between apps in Android.
   */
  appPackageName?: string
  /**
   * A merchant URL user moves to after requesting the payment.
   */
  confirmUrl: string
  /**
   * A navigation type of the ConfirmURL after user approves the payment request.
   */
  confirmUrlType?: string
  /**
   * A URL that moves to the next when LINE Pay member cancels the payment from the payment page.
   */
  cancelUrl: string
}

export type Payment = {
  /**
   * Regarding automatic payment
   * - True: Processing authorization and purchase with the Confirm API at the same time
   * - False: Authorized with the Confirm API but need to purchase with the Capture API.
   *
   * Note that this field is not available by default. Users should contact LINE Pay to activate manually.
   */
  capture?: boolean
  /**
   * Payment options
   * - NORMAL
   * - PREAPPROVED
   */
  payType?: 'NORMAL' | 'PREAPPROVED'
}

export type Display = {
  /**
   * Language codes of the payment standby screen. The default language is English (en).
   * - Supported languages: en, ja, ko, th, zh_TW, zh_CN
   */
  locale?: string
  /**
   * Checking the payment browser when moving to the ConfirmURL
   * - True : Guide user to go to the LINE Pay payment request browser if payment request browser and the ConfirmURL navigation browser are different.
   * - False : Move the the ConfirmURL immediately without checking the browser
   */
  checkConfirmUrlBrowser?: boolean
}

export type Shipping = {
  /**
   * Shipping address options
   * - NO_SHIPPING
   * - FIXED_ADDRESS
   * - SHIPPING
   */
  type?: string
  /**
   * Shipping fee
   */
  feeAmount?: number
  /**
   * A URL to check shipping method
   */
  feeInquiryUrl?: string
  /**
   * Shipping fee options
   * - CONDITION : Check the shipping method (fee) when the shipping address is changed.
   * - FIXED : If fixed, not checking the shipping address even after it is changed.
   */
  feeInquiryType?: string
  /**
   * Shipping address
   */
  address?: Address
}

export type AddFriend = {
  /**
   * Service type of the friend add list
   * - lineAt
   */
  type?: string
  /**
   * A list of ID by service
   */
  idList?: string[]
}

export type FamilyService = {
  /**
   * Service type of the family service list
   */
  addFriends?: AddFriend[]
}

export type Extra = {
  /**
   * Branch Name where the payment is requested from (Only 100 letters will be displayed if it's exceeded.)
   */
  branchName?: string
  /**
   * Branch Id where the payment is requested.\
   * It can be support alphabets, numbers and special characters.
   */
  branchId?: string
}

export type Options = {
  /**
   * Payment options
   */
  payment?: Payment
  /**
   * Display options
   */
  display?: Display
  /**
   * Shipping options
   */
  shipping?: Shipping
  /**
   * Family service options
   */
  familyService?: FamilyService
  /**
   * Extra options
   */
  extra?: Extra
}

export type RequestRequestBody = {
  /**
   * Payment amount\
   * `= sum(packages[].amount) + sum(packages[].userFee) + options.shipping.feeAmount`
   */
  amount: number
  /**
   * Payment currency (ISO 4217)
   * - Supported currencies: USD, JPY, TWD, THB
   */
  currency: Currency
  /**
   * An order ID of payment request from the merchant
   * - An unique ID managed by the merchant
   */
  orderId: string
  /**
   * Package list
   */
  packages: Package[]
  /**
   * Redirect URLs
   */
  redirectUrls: RedirectUrls
  /**
   * options
   */
  options?: Options
}

export type RequestRequestConfig = GeneralRequestConfig & {
  /**
   * Request body of request API
   */
  body: RequestRequestBody
}

Response Body

export type PaymentUrl = {
  /**
   * App URL to move to the payment page
   * - Used when payment reservation is done in the app
   * - URL to move from the merchant app to the LINE Pay.
   */
  app: string
  /**
   * 	Web URL to move to the payment page
   * - Used when payment reservation is done in the web
   * - URL to move to the LINE Pay payment standby page
   * - Move to URL that is delivered without particular parameter
   * - If opening a pop-up in the desktop, follow the size: Width: 700px, Height : 546px
   */
  web: string
}

export type Info = {
  /**
   * Transaction ID
   */
  transactionId: string
  /**
   * The code value entered when code is used instead of scanner in the LINE Pay.
   */
  paymentAccessToken: string
  /**
   * Payment URL
   */
  paymentUrl: PaymentUrl
}

export type RequestResponseBody = GeneralResponseBody & {
  /**
   * Payment information
   */
  info: Info
}

Return Code

Success

Code	Description
0000	Success

Error

Code	Description
1104	Non-existing merchant
1105	The merchant cannot use the LINE Pay.
1106	A header information error
1124	An amount info error
1145	Payment in process
1172	A record of transaction with the same order number already exists.
1178	Unsupported currency
1183	The payment amount must be less than 0.
1194	The merchant cannot use the preapproved payment.
2101	A parameter error
2102	A JSON data format error
9000	An internal error

Example

Request

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

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": {}
}

addHandler

addHandler(handler)

Returns RequestClient

Example:

client.addHandler(({ type, req, next, httpClient }) => {
  console.log(type) // request
  return next(req)
})

addHandlers

addHandlers(...handlers)

Returns RequestClient

Example:

client.addHandlers(
  ({ req, next }) => next(req),
  ({ req, next }) => next(req),
  ({ req, next }) => next(req)
)