LINE Pay SDK for PHP
LINE Pay SDK for PHP
[](https://packagist.org/packages/yidas/line-pay-sdk)
[](https://packagist.org/packages/yidas/line-pay-sdk)
[](https://packagist.org/packages/yidas/line-pay-sdk)
English | [繁體中文](https://github.com/yidas/line-pay-sdk-php/blob/v3/README-zh_TW.md)
|SDK Version|Online API Version|Offline API Version|
|:-:|:-:|:-:|
|v3 (Current)|[v3](https://pay.line.me/tw/developers/apis/onlineApis?locale=en_US)|[v2](https://pay.line.me/tw/developers/apis/documentOffline?locale=en_US)|
|[v2](https://github.com/yidas/line-pay-sdk-php/tree/v2)|[v2](https://pay.line.me/documents/online_v2_en.html)|[v2](https://pay.line.me/tw/developers/apis/documentOffline?locale=en_US)|
OUTLINE
-------
- [Demonstration](#demonstration)
- [Requirements](#requirements)
- [Authentication](#authentication)
- [Installation](#installation)
- [Usage](#usage)
- [Client](#client)
- [Device Information](#device-information)
- [Response](#response)
- [Retrieving Data](#retrieving-data)
- [Retrieving as Object](#retrieving-as-object)
- [Retrieving as Array](#retrieving-as-array)
- [Methods](#methods)
- [isSuccessful()](#issuccessful)
- [getPaymentUrl()](#getpaymenturl)
- [getPayInfo()](#getpayinfo)
- [toArray()](#toarray)
- [toObject()](#toobject)
- [getStats()](#getstats)
- [Online APIs](#online-apis)
- [Payment Details API](#payment-details-api)
- [Request API](#request-api)
- [Confirm API](#confirm-api)
- [Refund API](#refund-api)
- [Check Payment Status API](#check-payment-status-api)
- [Capture API](#capture-api)
- [Void API](#void-api)
- [Pay Preapproved API](#pay-preapproved-api)
- [Check RegKey API](#check-regkey-api)
- [Expire RegKey API](#expire-regkey-api)
- [Offline APIs](#offline-apis)
- [Payment](#payment)
- [Payment Status Check](#payment-status-check)
- [Void](#void)
- [Capture](#capture)
- [Refund](#refund)
- [Authorization Details](#authorization-details)
- [Exceptions](#exceptions)
- [ConnectException](#connectException)
- [Resources](#resources)
- [References](#references)
---
DEMONSTRATION
-------------
[Sample Codes Site for LINE Pay (Request, Confirm, Refund)](https://github.com/yidas/line-pay-sdk-php/tree/v3/sample)
```php
// Create LINE Pay client
$linePay = new \yidas\linePay\Client([
'channelId' => 'Your merchant X-LINE-ChannelId',
'channelSecret' => 'Your merchant X-LINE-ChannelSecret',
'isSandbox' => true,
]);
// Online Request API
$response = $linePay->request([
'amount' => 250,
'currency' => 'TWD',
'orderId' => 'Your order ID',
'packages' => [
[
'id' => 'Your package ID',
'amount' => 250,
'name' => 'Your package name',
'products' => [
[
'name' => 'Your product name',
'quantity' => 1,
'price' => 250,
'imageUrl' => 'https://yourname.com/assets/img/product.png',
],
],
],
],
'redirectUrls' => [
'confirmUrl' => 'https://yourname.com/line-pay/confirm',
'cancelUrl' => 'https://yourname.com/line-pay/cancel',
],
]);
// Check Request API result (returnCode "0000" check method)
if (!$response->isSuccessful()) {
throw new Exception("ErrorCode {$response['returnCode']}: {$response['returnMessage']}");
}
// Redirect to LINE Pay payment URL
header('Location: '. $response->getPaymentUrl() );
```
> [LINE Pay API Tool for testing and loging APIs](https://github.com/yidas/line-pay-sdk-php/tree/v3/tool)
---
REQUIREMENTS
------------
This library requires the following:
- PHP 5.4.0+\|7.0+
- guzzlehttp/guzzle 5.3.1+\|6.0+
- [LINE Pay merchant authentication](#authentication)
### Authentication
Each LINE Pay merchant Requires authentication information for LINE Pay integration, as shown below:
- channel ID
- channel Secret
To get an LINE Pay Authentication:
1. Merchant's verification information can be viewed at [LINE Pay Merchant Center](http://pay.line.me) after evaluation process is
complete.
2. Login into [LINE Pay Merchant Center](http://pay.line.me), then **get the ChannelId/ChannelSecret** (Payment Integration Management > Manage Link Key).
3. In [LINE Pay Merchant Center](http://pay.line.me), **set IP white list** for your servers (Payment Integration Management > Manage Payment Server IP) *(v3 is not required)*.
> You can immediately create a sandbox merchant account for test through [LINE Pay Sandbox Creation](https://pay.line.me/tw/developers/techsupport/sandbox/creation?locale=en_US).
---
INSTALLATION
------------
Run Composer in your project:
composer require yidas/line-pay-sdk ~3.0.0
Then you could use SDK class after Composer is loaded on your PHP project:
```php
require __DIR__ . '/vendor/autoload.php';
use yidas\linePay\Client;
```
---
USAGE
-----
Before using any API methods, first you need to create a Client with configuration, then use the client to access LINE Pay API methods.
### Client
Create a LINE Pay Client with [API Authentication](#authentication):
```php
$linePay = new \yidas\linePay\Client([
'channelId' => 'Your merchant X-LINE-ChannelId',
'channelSecret' => 'Your merchant X-LINE-ChannelSecret',
'isSandbox' => true,
]);
```
#### Device Information
You could set device information for Client (Optional):
```php
$linePay = new \yidas\linePay\Client([
'channelId' => 'Your merchant X-LINE-ChannelId',
'channelSecret' => 'Your merchant X-LINE-ChannelSecret',
'isSandbox' => true,
'merchantDeviceType' => 'Device type string',
'merchantDeviceProfileId' => 'Device profile ID string',
]);
```
### Response
Each API methods will return `yidas\linePay\Response` object, which can retrieve data referred to LINE Pay JSON response data structure.
#### Retrieving Data
Response object provides response body data accessing by object attributes or array keys:
##### Retrieving as Object
```php
// Get object of response body
$bodyObject = response->toObject();
// Get LINE Pay results code from response
$returnCode = $response->returnCode;
// Get LINE Pay info.payInfo[] from response
$payInfo = $response->info->payInfo;
```
##### Retrieving as Array
```php
// Get array of response body
$bodyArray = response->toArray();
// Get LINE Pay results code from response
$returnCode = $response['returnCode'];
// Get LINE Pay info.payInfo[] from response
$payInfo = $response['info']['payInfo'];
```
#### Methods
Response object has some helpful methods to use:
##### isSuccessful()
LINE Pay API result successful status (Check that returnCode is "0000")
*Example:*
```php
if (!$response->isSuccessful()) {
throw new Exception("Code {$response['returnCode']}: {$response['returnMessage']}");
}
```
##### getPaymentUrl()
Get LINE Pay API response body's info.paymentUrl (Default type is "web")
##### getPayInfo()
Get LINE Pay API response body's info.payInfo[] or info.[$param1].payInfo[] as array
##### toArray()
Get LINE Pay response body as array
##### toObject()
Get LINE Pay response body as object
##### getStats()
Get `\GuzzleHttp\TransferStats` object
### Online APIs
For Web integration. Merchant will requests a payment and generates payment URL(QR code) to customer to scan by LINE App.
> Flow: [`Request`](#request-api) -> [`Confirm`](#confirm-api) -> [`Details`](#payment-details-api) -> [`Refund`](#refund-api)
#### Payment Details API
Gets the details of payments made with LINE Pay. This API only gets the payments that have been captured.
```php
public Response details(array $queryParams=null)
```
*Example:*
```php
$response = $linePay->details([
"transactionId" => [$transactionId],
]);
```
#### Request API
Prior to processing payments with LINE Pay, the Merchant is evaluated if it is a normal Merchant store then the information is requested for payment.
When a payment is successfully requested, the Merchant gets a "transactionId" that is a key value used until the payment is completed or refunded.
```php
public Response request(array $bodyParams=null)
```
*Example:*
```php
$response = $linePay->request([
'amount' => 250,
'currency' => 'TWD',
'orderId' => 'Your order ID',
'packages' => [
[
'id' => 'Your package ID',
'amount' => 250,
'name' => 'Your package name',
'products' => [
[
'name' => 'Your product name',
'quantity' => 1,
'price' => 250,
'imageUrl' => 'https://yourname.com/assets/img/product.png',
],
],
],
],
'redirectUrls' => [
'confirmUrl' => 'https://yourname.com/line-pay/confirm',
'cancelUrl' => 'https://yourname.com/line-pay/cancel',
],
]);
```
> The `$bodyParams` specification can be referred to [Request API v3 Request Body](https://pay.line.me/documents/online_v3_en.html#request-api)
#### Confirm API
This API is used for a Merchant to complete its payment. The Merchant must call Confirm Payment API to actually complete the payment.
However, when "capture" parameter is "false" on payment reservation, the payment status becomes AUTHORIZATION, and the payment is completed only after "Capture API" is called.
```php
public Response confirm(integer $transactionId, array $bodyParams=null)
```
*Example:*
```php
$response = $linePay->confirm($transactionId, [
"amount" => 250,
"currency" => 'TWD',
]);
```
#### Refund API
Requests refund of payments made with LINE Pay.
To refund a payment, the LINE Pay user's payment transactionId must be forwarded. A partial refund is also possible depending on the refund amount.
```php
public Response refund(integer $transactionId, array $bodyParams=null)
```
*Example:*
```php
$response = $linePay->refund($transactionId);
```
*For Partial refund:*
```php
$response = $linePay->refund($transactionId, [
'refundAmount' => 200,
]);
```
#### Check Payment Status API
An API to check payment request status of LINE Pay. The merchant should regularly check user payment confirm status **without using the ConfirmURL** and decide if it is possible to complete the payment.
```php
public Response check(integer $transactionId)
```
*Example:*
```php
$response = $linePay->check($transactionId);
```
#### Capture API
If "capture" is "false" when the Merchant calls the “Request API” , the payment is completed only after the Capture API is called.
```php
public Response authorizationsCapture(integer $transactionId, array $bodyParams=null)
```
*Example:*
```php
$response = $linePay->authorizationsCapture($transactionId, [
"amount" => 250,
"currency" => 'TWD',
]);
```
#### Void API
Voids a previously authorized payment. A payment that has been already captured can be refunded by using the “Refund API”.
```php
public Response authorizationsVoid(integer $transactionId, array $bodyParams=null)
```
*Example:*
```php
$response = $linePay->authorizationsVoid($transactionId);
```
#### Pay Preapproved API
When the payment type of the Request API was set as PREAPPROVED, a regKey is returned with the payment result.
Pay Preapproved API uses this regKey to directly complete a payment without using the LINE app.
```php
public Response preapproved(integer $regKey, array $bodyParams=null)
```
*Example:*
```php
$response = $linePay->preapproved([
'productName' => 'Your product name',
'amount' => 250,
'currency' => 'TWD',
'orderId' => 'Your order ID',
]);
```
#### Check RegKey API
Checks if regKey is available before using the preapproved payment API.
```php
public Response preapprovedCheck(integer $regKey, array $queryParams=null)
```
*Example:*
```php
$response = $linePay->preapprovedCheck($regKey);
```
#### Expire RegKey API
Expires the regKey information registered for preapproved payment. Once the API is called, the regKey is no longer used for preapproved payments.
```php
public Response preapprovedExpire(integer $regKey, array $bodyParams=null)
```
*Example:*
```php
$response = $linePay->preapprovedExpire($regKey);
```
### Offline APIs
For POS integration. Customer presents their barcode or QR code to merchants to scan at the POS machine.
> Flow: [`OneTimeKeysPay`](#payment) -> [`OrdersCheck`](#payment-status-check) -> [`OrdersRefund`](#refund)
#### Payment
This API is to process payment by reading MyCode provided from LINE Pay App with Merchant's device.
```php
public Response oneTimeKeysPay(array $bodyParams=null)
```
*Example:*
```php
$response = $linePay->oneTimeKeysPay([
'productName' => 'Your product name',
'amount' => 250,
'currency' => 'TWD',
'productImageUrl' => 'https://yourname.com/assets/img/product.png',
'orderId' => 'Your order ID',
"oneTimeKey"=> 'LINE Pay MyCode',
]);
```
#### Payment Status Check
It's the API used when the final payment status can't be checked due to read timeout.
- The status needs to be checked by calling it at regular intervals and 3~5 seconds are recommended for the interval time.
- Payment valid time is maximum 20 minutes and it's calculated from the Payment API Response time. Therefore, a merchant should check the payment status for maximum 20 minutes. In case 20 minutes are exceeded, that transaction will be the payment that couldn't be completed due to exceeded valid time.
```php
public Response ordersCheck(string $orderId, array $$queryParams=null)
```
*Example:*
```php
$response = $linePay->ordersCheck($orderId);
```
#### Void
This API is to void the authorization.
```php
public Response ordersVoid(string $orderId, array $bodyParams=null)
```
*Example:*
```php
$response = $linePay->ordersVoid($orderId);
```
#### Capture
This API is to capture the authorized transaction.
```php
public Response ordersCapture(string $orderId, array $bodyParams=null)
```
*Example:*
```php
$response = $linePay->ordersCapture($orderId);
```
#### Refund
This API is to refund after the payment completion (Captured data).
```php
public Response ordersRefund(string $orderId, array $bodyParams=null)
```
*Example:*
```php
$response = $linePay->ordersRefund($orderId);
```
#### Authorization Details
This API is to search the authorization details. Only authorized or cancelled (Void or Expire) data can be searched and the data after capturing can be searched by The Payment Details API.
```php
public Response authorizations(array $queryParams=null)
```
*Example for searching transactionId:*
```php
$response = $linePay->authorizations([
"transactionId" => [$transactionId],
]);
```
*Example for searching orderId:*
```php
$response = $linePay->authorizations([
"orderId" => $orderId,
]);
```
---
EXCEPTIONS
----------
Client throws exceptions for errors that occur during a API transaction.
### ConnectException
A `yidas\linePay\exception\ConnectException` exception is thrown in the event of a networking error (Timeout).
```php
try {
$response = $linePay->confirm($transactionId, $bodyParams);
} catch (\yidas\linePay\exception\ConnectException $e) {
// Process of confirm API timeout handling
}
```
---
RESOURCES
---------
**[LINE Pay Online API v3 Guide (EN)](https://pay.line.me/tw/developers/apis/onlineApis?locale=en_US)**
**[LINE Pay Offline API v2 Guide (EN)](https://pay.line.me/tw/developers/apis/documentOffline?locale=en_US)**
[LINE Pay Sandbox creation](https://pay.line.me/tw/developers/techsupport/sandbox/creation?locale=en_US)
[LINE Pay OneTimeKeys Simulation](https://sandbox-web-pay.line.me/web/sandbox/payment/otk)
[LINE Pay OneTimeKeys Simulation (For TW Merchant)](https://sandbox-web-pay.line.me/web/sandbox/payment/oneTimeKey?countryCode=TW&paymentMethod=card&preset=1)
[LINE Pay Online API v2 Documents PDF version (Multi-language)](https://pay.line.me/tw/developers/documentation/download/tech?locale=en_US)
---
REFERENCES
----------
[LINE Pay Developers - APIs](https://pay.line.me/tw/developers/apis/apis?locale=en_US)