payOS

https://payos.vn/docs
Admin
payOS is a payment platform providing APIs, SDKs, hosted and embedded checkout pages, webhooks and...
Tokens:50,166
Snippets:446
Trust Score:7.1
Update:2 months ago
Show doc for...
Tokens:
Raw
### Start Development Server

Source: https://payos.vn/docs/checkout/quick-start-payos-embedded-form

Execute the start script to launch the application.

```bash
npm run start
```

--------------------------------

### Install payOS Golang SDK

Source: https://payos.vn/docs/sdks/back-end/golang

Use go get to add the payOS library to your project.

```bash
go get github.com/payOSHQ/payos-lib-golang/v2
```

--------------------------------

### Run the Go server

Source: https://payos.vn/docs/checkout/quick-start-payos-hosted-page

Command to start the local development server.

```bash
go run server.go
```

--------------------------------

### Start Node.js Server

Source: https://payos.vn/docs/checkout/quick-start-payos-hosted-page

Command to launch the local development server.

```bash
npm start
```

--------------------------------

### Install PayOS SDK

Source: https://payos.vn/docs/sdks/back-end/node

Install the package using npm or yarn.

```bash
npm install @payos/node
# hoặc
yarn add @payos/node
```

--------------------------------

### Run Development Servers

Source: https://payos.vn/docs/checkout/quick-start-payos-hosted-page

Commands to start the Go backend and the React frontend locally.

```bash
# server side
go run server.go

# client side
npm start
```

--------------------------------

### Install PHP SDK

Source: https://payos.vn/docs/sdks/intro

Use composer to install the payOS library for PHP.

```bash
composer require payos/payos
```

--------------------------------

### Initialize PayOS Client

Source: https://payos.vn/docs/sdks/back-end/python

Setup the PayOS instance using credentials from environment variables.

```python
from payos import PayOS
import os

# Khởi tạo từ biến môi trường
payOS = PayOS(
    client_id=os.environ.get('PAYOS_CLIENT_ID'),
    api_key=os.environ.get('PAYOS_API_KEY'),
    checksum_key=os.environ.get('PAYOS_CHECKSUM_KEY')
)
```

--------------------------------

### Install Python SDK

Source: https://payos.vn/docs/sdks/intro

Install the payOS package using pip for Windows or pip3 for Linux/macOS.

```bash
# Windows
pip install payos

# Linux/macOS
pip3 install payos
```

--------------------------------

### Run .NET Server

Source: https://payos.vn/docs/checkout/quick-start-payos-hosted-page

Command to start the local development server.

```bash
dotnet run
```

--------------------------------

### Install PayOS Checkout Library

Source: https://payos.vn/docs/checkout/quick-start-payos-embedded-form

Commands to install the frontend checkout library for React applications.

```bash
npm install @payos/payos-checkout
# hoặc
yarn add @payos/payos-checkout
```

--------------------------------

### Run Development Servers

Source: https://payos.vn/docs/checkout/quick-start-payos-hosted-page

Commands to start the .NET backend and React frontend development environments.

```bash
# server side
dotnet run

# client side
npm start
```

--------------------------------

### Install payOS SDK for .NET

Source: https://payos.vn/docs/checkout/quick-start-payos-hosted-page

Commands to install the payOS package via .NET CLI or NuGet Package Manager.

```bash
dotnet add package payOS
```

```powershell
Install-Package payOS
```

--------------------------------

### Run Development Servers

Source: https://payos.vn/docs/checkout/quick-start-payos-hosted-page

Commands to start the Flask backend and React frontend for local testing.

```bash
# server side
flask run --port=3030

# client side
npm start
```

--------------------------------

### Install payOS package

Source: https://payos.vn/docs/sdks/back-end/net

Use the dotnet CLI to add the payOS package to your project.

```bash
dotnet add package payOS
```

--------------------------------

### Start Local Development Server

Source: https://payos.vn/docs/checkout/quick-start-payos-hosted-page

Run this command in your terminal to start the PHP built-in server at localhost:3030.

```bash
php -S localhost:3030 --docroot=public
```

--------------------------------

### Configure Development Server

Source: https://payos.vn/docs/checkout/quick-start-payos-hosted-page

Commands to start the PHP backend server and the React frontend development server.

```bash
# server side
php -S localhost:3030 --docroot=public

# client side
npm start
```

--------------------------------

### Run Flask Server

Source: https://payos.vn/docs/checkout/quick-start-payos-hosted-page

Command to start the local development server on port 3030.

```bash
flask run --port=3030
```

--------------------------------

### Install Node.js SDK

Source: https://payos.vn/docs/sdks/intro

Use npm or yarn to add the payOS package to your Node.js project.

```bash
npm install @payos/node --save
```

```bash
yarn add @payos/node
```

--------------------------------

### Install PayOS Java SDK dependencies

Source: https://payos.vn/docs/sdks/back-end/java

Add the required dependency to your project configuration file.

```xml
<dependency>
  <groupId>vn.payos</groupId>
  <artifactId>payos-java</artifactId>
  <version>2.0.1</version>
</dependency>
```

```gradle
implementation 'vn.payos:payos-java:2.1.0'
```

--------------------------------

### Install payOS SDK via Script Tag

Source: https://payos.vn/docs/sdks/front-end/script-js

Include this script tag directly from the payOS CDN in your HTML to initialize the SDK.

```html
<script src='https://cdn.payos.vn/payos-checkout/v1/stable/payos-initialize.js'></script>
```

--------------------------------

### Integrate Web SDK

Source: https://payos.vn/docs/sdks/intro

Include the payOS checkout script via CDN or install the package for ReactJS.

```html
<script src='https://cdn.payos.vn/payos-checkout/v1/stable/payos-initialize.js'></script>
```

```bash
npm install payos-checkout
```

--------------------------------

### Configure package.json for Proxy and Scripts

Source: https://payos.vn/docs/checkout/quick-start-payos-embedded-form

Add proxy settings and concurrent start scripts to your package.json to manage both client and server processes.

```json
"proxy": "http://localhost:3030",
"scripts": {
    # another scripts
    "start-client": "react-scripts start",
    "start-server": "nodemon server.js",
    "start": "concurrently \"npm run start-client\" \"npm run start-server\""
},
```

--------------------------------

### Server Implementation for Payment Links

Source: https://payos.vn/docs/checkout/quick-start-payos-hosted-page

Java server setup using Spark framework to handle payment link creation requests.

```java
package vn.payos.sample;

import static spark.Spark.port;
import static spark.Spark.post;
import static spark.Spark.staticFiles;

import java.nio.file.Paths;
import vn.payos.PayOS;
import vn.payos.model.v2.paymentRequests.CreatePaymentLinkRequest;
import vn.payos.model.v2.paymentRequests.CreatePaymentLinkResponse;

public class Server {
  public static void main(String[] args) {
    port(3000);
    String clientId = "YOUR_CLIENT_ID";
    String apiKey = "YOUR_API_KEY";
    String checksumKey = "YOUR_CHECKSUM_KEY";

    final PayOS payOS = new PayOS(clientId, apiKey, checksumKey);

    staticFiles.externalLocation(Paths.get("public").toAbsolutePath().toString());

    post(
        "/create-payment-link",
        (request, response) -> {
          String domain = "http://localhost:3000";
          Long orderCode = System.currentTimeMillis() / 1000;
          CreatePaymentLinkRequest paymentData =
              CreatePaymentLinkRequest.builder()
                  .orderCode(orderCode)
                  .amount(2000)
                  .description("Thanh toán đơn hàng")
                  .returnUrl(domain + "/success.html")
                  .cancelUrl(domain + "/cancel.html")
                  .build();

          CreatePaymentLinkResponse result = payOS.paymentRequests().create(paymentData);
          response.redirect(result.getCheckoutUrl(), 303);
          return "";
        });
  }
}
```

--------------------------------

### Install payos-checkout via CDN

Source: https://payos.vn/docs/checkout/quick-start-payos-embedded-form

Include the PayOS checkout library in your HTML file to enable payment functionality.

```html
<script src="https://cdn.payos.vn/payos-checkout/v1/stable/payos-initialize.js"></script>
```

--------------------------------

### Express Server Implementation

Source: https://payos.vn/docs/checkout/quick-start-payos-hosted-page

Node.js server setup using Express and the PayOS SDK to handle payment link generation.

```javascript
const express = require('express');
const dotenv = require('dotenv');
const cors = require('cors');
const { PayOS } = require('@payos/node');

const app = express();
dotenv.config();
const payOS = new PayOS({
  clientId: process.env.PAYOS_CLIENT_ID,
  apiKey: process.env.PAYOS_API_KEY,
  checksumKey: process.env.PAYOS_CHECKSUM_KEY,
});

app.use(cors());
app.use(express.json());
app.use(express.urlencoded({ extended: false }));

app.use('/', express.static('public'));

app.post('/create-payment-link', async (req, res) => {
  const YOUR_DOMAIN = `http://localhost:3030`;
  const body = {
    orderCode: Number(String(Date.now()).slice(-6)),
    amount: 2000,
    description: 'Thanh toan don hang',
    items: [
      {
        name: 'Mì tôm Hảo Hảo ly',
        quantity: 1,
        price: 2000,
      },
    ],
    returnUrl: `${YOUR_DOMAIN}/success.html`,
    cancelUrl: `${YOUR_DOMAIN}/cancel.html`,
  };

  try {
    const paymentLinkResponse = await payOS.paymentRequests.create(body);

    res.redirect(paymentLinkResponse.checkoutUrl);
  } catch (error) {
    console.error(error);
    res.send('Something went error');
  }
});

app.listen(3030, function () {
  console.log(`Server is listening on port 3030`);
});
```

--------------------------------

### Payment Request Success Response

Source: https://payos.vn/docs/api

Example response returned upon successful creation of a payment link.

```json
{
"code": "00",
"desc": "success",
"data": {
"bin": "970422",
"accountNumber": "113366668888",
"accountName": "QUY VAC XIN PHONG CHONG COVID",
"amount": 10000,
"description": "THANH TOAN DON HANG 123",
"orderCode": 123,
"currency": "VND",
"paymentLinkId": "124c33293c934a85be5b7f8761a27a07",
"status": "PENDING",
"checkoutUrl": "https://pay.payos.vn/web/124c33293c934a85be5b7f8761a27a07",
"qrCode": "00020101021238570010A000000727012700069704220113113366668888020899998888530370454061000005802VN62230819THANH TOAN DON HANG6304BE36"
},
"signature": "aec38349957f1a6c22ded683d06477ac5dfe047cf5f23c70dc8e048759ef1234"
}
```

--------------------------------

### Estimate Credit Response

Source: https://payos.vn/docs/api

Example JSON response for a successful payout cost estimation request.

```json
{
"code": "00",
"desc": "success",
"data": {
"estimateCredit": 5000
}
}
```

--------------------------------

### Create Single Payout Success Response

Source: https://payos.vn/docs/api

Example JSON response returned upon a successful payout creation request.

```json
{
"code": "00",
"desc": "success",
"data": {
"id": "payout_123456789",
"referenceId": "ref_123456789",
"transactions": {
"0": {
"id": "txn_123456789",
"referenceId": "ref_123456789",
"amount": 100000,
"description": "Thanh toan",
"toBin": "970422",
"toAccountNumber": "123456789",
"toAccountName": "NGUYEN VAN A",
"state": "PROCESSING"
}
},
"category": {
"0": "salary"
},
"approvalState": "PROCESSING",
"createdAt": "2024-01-15T10:30:00.000Z"
}
}
```

--------------------------------

### Implement PayOS Embedded Payment in React

Source: https://payos.vn/docs/checkout/quick-start-payos-embedded-form

A full React component example using the usePayOS hook to manage an embedded payment flow, including state management for the checkout URL and container visibility.

```javascript
import React, { useState, useEffect } from "react";
import { usePayOS } from "@payos/payos-checkout";
import "./App.css";

const ProductDisplay = () => {
  const [isOpen, setIsOpen] = useState(false);
  const [message, setMessage] = useState("");
  const [isCreatingLink, setIsCreatingLink] = useState(false);

  const [payOSConfig, setPayOSConfig] = useState({
    RETURN_URL: window.location.href, // required
    ELEMENT_ID: "embedded-payment-container", // required
    CHECKOUT_URL: null, // required
    embedded: true, // Nếu dùng giao diện nhúng
    onSuccess: (event) => {
      //TODO: Hành động sau khi người dùng thanh toán đơn hàng thành công
      setIsOpen(false);
      setMessage("Thanh toan thanh cong");
    },
  });

  const { open, exit } = usePayOS(payOSConfig);

  const handleGetPaymentLink = async () => {
    setIsCreatingLink(true);
    exit();
    const response = await fetch(
      "http://localhost:3030/create-embedded-payment-link",
      {
        method: "POST",
      }
    );
    if (!response.ok) {
      console.log("Server doesn't response");
    }

    const result = await response.json();
    setPayOSConfig((oldConfig) => ({
      ...oldConfig,
      CHECKOUT_URL: result.checkoutUrl,
    }));

    setIsOpen(true);
    setIsCreatingLink(false);
  };

  useEffect(() => {
    if (payOSConfig.CHECKOUT_URL != null) {
      open();
    }
  }, [payOSConfig]);
  return message ? (
    <Message message={message} />
  ) : (
    <div className="main-box">
      <div>
        <div className="checkout">
          <div className="product">
            <p>
              <strong>Tên sản phẩm:</strong> Mì tôm Hảo Hảo ly
            </p>
            <p>
              <strong>Giá tiền:</strong> 2000 VNĐ
            </p>
            <p>
              <strong>Số lượng:</strong> 1
            </p>
          </div>
          <div className="flex">
            {!isOpen ? (
              <div>
                {isCreatingLink ? (
                  <div
                    style={{
                      textAlign: "center",
                      padding: "10px",
                      fontWeight: "600",
                    }}
                  >
                    Creating Link...
                  </div>
                ) : (
                  <button
                    id="create-payment-link-btn"
                    onClick={(event) => {
                      event.preventDefault();
                      handleGetPaymentLink();
                    }}
                  >
                    Tạo Link thanh toán Embedded
                  </button>
                )}
              </div>
            ) : (
              <button
                style={{
                  backgroundColor: "gray",
                  color: "white",
                  width: "100%",
                  paddingTop: "10px",
                  paddingBottom: "10px",
                  fontSize: "14px",
                  marginTop: "5px",
                }}
                onClick={(event) => {
                  event.preventDefault();
                  setIsOpen(false);
                  exit();
                }}
              >
                Đóng Link
              </button>
            )}
          </div>
        </div>
        {isOpen && (
          <div style={{ maxWidth: "400px", padding: "2px" }}>
            Sau khi thực hiện thanh toán thành công, vui lòng đợi từ 5 - 10s để
            hệ thống tự động cập nhật.
          </div>
        )}
        <div
          id="embedded-payment-container"
          style={{
            height: "350px",
          }}
        ></div>
      </div>
    </div>
  );
};

const Message = ({ message }) => (
  <div className="main-box">
    <div className="checkout">
      <div class="product" style={{ textAlign: "center", fontWeight: "500" }}>
        <p>{message}</p>
      </div>
      <form action="/">
        <button type="submit" id="create-payment-link-btn">
          Quay lại trang thanh toán
        </button>
      </form>
    </div>
  </div>
);

export default function App() {
  return <ProductDisplay />;
}
```

--------------------------------

### Configure Proxy and Run Server

Source: https://payos.vn/docs/checkout/quick-start-payos-hosted-page

Add the proxy configuration to package.json and execute the server and client commands.

```bash
# server side
java -cp .\target\payos-payment-1.0-SNAPSHOT-jar-with-dependencies.jar vn.payos.sample.Server

# client side
npm start
```

--------------------------------

### GET /v1/payouts-account/balance

Source: https://payos.vn/docs/api

Retrieves the current balance information for the payout account.

```APIDOC
## GET /v1/payouts-account/balance

### Description
API used to retrieve the balance information of the payout account.

### Method
GET

### Endpoint
https://api-merchant.payos.vn/v1/payouts-account/balance

### Response
#### Success Response (200)
- **code** (string) - Status code
- **desc** (string) - Status description
- **data** (object) - Account balance details
  - **accountNumber** (string) - Account number
  - **accountName** (string) - Account name
  - **currency** (string) - Currency code
  - **balance** (string) - Current balance

#### Response Example
{
  "code": "00",
  "desc": "success",
  "data": {
    "accountNumber": "123456789",
    "accountName": "CONG TY ABC",
    "currency": "VND",
    "balance": "1000000"
  }
}
```

--------------------------------

### Go server implementation

Source: https://payos.vn/docs/checkout/quick-start-payos-hosted-page

Main server file handling PayOS client initialization and payment link creation.

```go
package main

import (
	"log"
	"net/http"
	"time"

	"github.com/payOSHQ/payos-lib-golang/v2"
)

var payOSClient *payos.PayOS

func main() {
	// Keep your PayOS key protected by including it by an env variable
	const clientId = "YOUR_CLIENT_ID"
	const apiKey = "YOUR_API_KEY"
	const checksumKey = "YOUR_CHECKSUM_KEY"

	var err error
	payOSClient, err = payos.NewPayOS(&payos.PayOSOptions{
		ClientID:    clientId,
		APIKey:      apiKey,
		ChecksumKey: checksumKey,
	})
	if err != nil {
		log.Fatalf("Failed to create PayOS client: %v", err)
	}

	http.Handle("/", http.FileServer(http.Dir("public")))
	http.HandleFunc("/create-payment-link", createPaymentLink)
	addr := "localhost:3030"
	log.Printf("Listening on %s", addr)
	log.Fatal(http.ListenAndServe(addr, nil))
}

func createPaymentLink(w http.ResponseWriter, r *http.Request) {
	domain := "http://localhost:3030"
	paymentLinkRequest := payos.CreatePaymentLinkRequest{
		OrderCode:   time.Now().UnixNano() / int64(time.Millisecond),
		Amount:      2000,
		Description: "Thanh toan don hang",
		CancelUrl:   domain + "/cancel.html",
		ReturnUrl:   domain + "/success.html",
	}

	paymentLinkResponse, err := payOSClient.PaymentRequests.Create(r.Context(), &paymentLinkRequest)

	if err != nil {
		log.Printf("Create payment link failed: %v", err)
	}

	http.Redirect(w, r, paymentLinkResponse.CheckoutUrl, http.StatusSeeOther)
}
```

--------------------------------

### Initialize PayOS Client

Source: https://payos.vn/docs/sdks/back-end/golang

Configure the PayOS client using environment variables for credentials.

```go
import (
    "context"
    "os"

    "github.com/payOSHQ/payos-lib-golang/v2/payos"
)

func main() {
    ctx := context.Background()

    client, err := payos.NewPayOS(&payos.PayOSOptions{
        ClientId:    os.Getenv("PAYOS_CLIENT_ID"),
        ApiKey:      os.Getenv("PAYOS_API_KEY"),
        ChecksumKey: os.Getenv("PAYOS_CHECKSUM_KEY"),
    })
    if err != nil {
        log.Fatal(err)
    }
}
```

--------------------------------

### GET /v1/payouts/{payoutId}

Source: https://payos.vn/docs/api

Retrieves detailed information about a specific payout order.

```APIDOC
## GET /v1/payouts/{payoutId}

### Description
API dùng để lấy thông tin chi tiết của một lệnh chi.

### Method
GET

### Endpoint
https://api-merchant.payos.vn/v1/payouts/{payoutId}

### Parameters
#### Path Parameters
- **payoutId** (string) - Required - ID của lệnh chi

### Response
#### Success Response (200)
- **code** (string) - Mã phản hồi
- **desc** (string) - Mô tả phản hồi
- **data** (object) - Thông tin chi tiết lệnh chi

#### Response Example
{
  "code": "00",
  "desc": "success",
  "data": {
    "id": "payout_123456789",
    "referenceId": "ref_123456789",
    "transactions": {
      "0": {
        "id": "txn_123456789",
        "amount": 100000,
        "state": "PROCESSING"
      }
    },
    "approvalState": "PROCESSING",
    "createdAt": "2024-01-15T10:30:00.000Z"
  }
}
```

--------------------------------

### Server Implementation in C#

Source: https://payos.vn/docs/checkout/quick-start-payos-hosted-page

The main server logic including startup configuration and the payment link creation endpoint.

```csharp
using Microsoft.AspNetCore;
using Microsoft.AspNetCore.Mvc;
using PayOS;
using PayOS.Models;

namespace server.Controllers
{
    public class Program
    {
        public static void Main(string[] args)
        {
            WebHost.CreateDefaultBuilder(args)
              .UseUrls("http://localhost:3030")
              .UseWebRoot("public")
              .UseStartup<Startup>()
              .Build()
              .Run();
        }
    }

    public class Startup
    {
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllers();
        }
        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            if (env.IsDevelopment()) app.UseDeveloperExceptionPage();
            app.UseRouting();
            app.UseStaticFiles();
            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllers();
                endpoints.MapGet("/", context =>
                {
                    context.Response.Redirect("/index.html");
                    return Task.CompletedTask;
                });
            });
        }
    }

    [Route("create-payment-link")]
    [ApiController]
    public class CheckoutApiController : Controller
    {
        [HttpPost]
        public async Task<IActionResult> Create()
        {
            // Keep your PayOS key protected by including it by an env variable
            var clientId = "YOUR_CLIENT_ID";
            var apiKey = "YOUR_API_KEY";
            var checksumKey = "YOUR_CHECKSUM_KEY";

            var payOS = new PayOSClient(clientId, apiKey, checksumKey);

            var domain = "http://localhost:3030";

            var paymentLinkRequest = new CreatePaymentLinkRequest
            {
                OrderCode = int.Parse(DateTimeOffset.Now.ToString("ffffff")),
                Amount = 2000,
                Description = "Thanh toan don hang",
                ReturnUrl = domain,
                CancelUrl = domain
            };
            var response = await payOS.PaymentRequests.CreateAsync(paymentLinkRequest);

            Response.Headers.Append("Location", response.CheckoutUrl);
            return new StatusCodeResult(303);
        }
    }
}
```

--------------------------------

### Initialize PayOS Go Server

Source: https://payos.vn/docs/checkout/quick-start-payos-hosted-page

Backend implementation for creating payment links using the PayOS Go library.

```go
package main

import (
	"log"
	"net/http"
	"time"

	"github.com/payOSHQ/payos-lib-golang/v2"
)

var payOSClient *payos.PayOS

func main() {
	// Keep your PayOS key protected by including it by an env variable
	const clientId = "YOUR_CLIENT_ID"
	const apiKey = "YOUR_API_KEY"
	const checksumKey = "YOUR_CHECKSUM_KEY"

	var err error
	payOSClient, err = payos.NewPayOS(&payos.PayOSOptions{
		ClientID:    clientId,
		APIKey:      apiKey,
		ChecksumKey: checksumKey,
	})
	if err != nil {
		log.Fatalf("Failed to create PayOS client: %v", err)
	}

	http.Handle("/", http.FileServer(http.Dir("public")))
	http.HandleFunc("/create-payment-link", createPaymentLink)
	addr := "localhost:3030"
	log.Printf("Listening on %s", addr)
	log.Fatal(http.ListenAndServe(addr, nil))
}

func createPaymentLink(w http.ResponseWriter, r *http.Request) {
	domain := "http://localhost:3030"
	paymentLinkRequest := payos.CreatePaymentLinkRequest{
		OrderCode:   time.Now().UnixNano() / int64(time.Millisecond),
		Amount:      2000,
		Description: "Thanh toan don hang",
		CancelUrl:   domain,
		ReturnUrl:   domain,
	}

	paymentLinkResponse, err := payOSClient.PaymentRequests.Create(r.Context(), &paymentLinkRequest)
```

--------------------------------

### GET /v1/payouts

Source: https://payos.vn/docs/api

Retrieves a list of payout orders based on optional filter parameters.

```APIDOC
## GET /v1/payouts

### Description
API dùng để lấy danh sách các lệnh chi.

### Method
GET

### Endpoint
https://api-merchant.payos.vn/v1/payouts

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Số lượng kết quả trên mỗi trang (Default: 10)
- **offset** (integer) - Optional - Vị trí bắt đầu (Default: 0)
- **referenceId** (string) - Optional - Mã tham chiếu để lọc
- **approvalState** (string) - Optional - Trạng thái phê duyệt để lọc
- **category** (string) - Optional - Danh mục để lọc (phân cách bằng dấu phẩy)
- **fromDate** (string) - Optional - Lọc từ ngày (ISO 8601 format)
- **toDate** (string) - Optional - Lọc đến ngày (ISO 8601 format)

### Response
#### Success Response (200)
- **code** (string) - Mã phản hồi
- **desc** (string) - Mô tả phản hồi
- **data** (object) - Dữ liệu lệnh chi

#### Response Example
{
  "code": "00",
  "desc": "success",
  "data": {
    "payouts": {
      "0": {
        "id": "payout_123456789",
        "referenceId": "ref_123456789",
        "transactions": {
          "0": {
            "id": "txn_123456789",
            "amount": 100000,
            "state": "SUCCEEDED"
          }
        },
        "approvalState": "SUCCEEDED"
      }
    },
    "pagination": {
      "total": 1,
      "limit": 10,
      "offset": 0
    }
  }
}
```

--------------------------------

### GET /v2/payment-requests/{id}/invoices

Source: https://payos.vn/docs/api

Retrieves the invoice information for a specific payment link.

```APIDOC
## GET /v2/payment-requests/{id}/invoices

### Description
API dùng để lấy thông tin hóa đơn của link thanh toán.

### Method
GET

### Endpoint
https://api-merchant.payos.vn/v2/payment-requests/{id}/invoices

### Parameters
#### Path Parameters
- **id** (number or string) - Required - Mã đơn hàng của cửa hàng hoặc mã link thanh toán của payOS

### Response
#### Success Response (200)
- **code** (string) - Status code
- **desc** (string) - Status description
- **data** (object) - Invoice data object
- **signature** (string) - Response signature

#### Response Example
{
  "code": "00",
  "desc": "success",
  "data": {
    "invoices": {
      "0": {
        "invoiceId": "INV123456",
        "invoiceNumber": "0000001",
        "issuedTimestamp": 1705312200000,
        "issuedDatetime": "2024-01-15T10:30:00.000Z",
        "transactionId": "TXN123",
        "reservationCode": "ABC123",
        "codeOfTax": "TAX001"
      }
    }
  },
  "signature": "dec38349957f1a6c22ded683d06477ac5dfe047cf5f23c70dc8e048759ef3456"
}
```

--------------------------------

### Initialize PayOSClient

Source: https://payos.vn/docs/sdks/back-end/net

Initialize the client using environment variables for credentials.

```csharp
using PayOS;

var payOS = new PayOSClient(
    Environment.GetEnvironmentVariable("PAYOS_CLIENT_ID"),
    Environment.GetEnvironmentVariable("PAYOS_API_KEY"),
    Environment.GetEnvironmentVariable("PAYOS_CHECKSUM_KEY")
);
```

--------------------------------

### Initialize PayOS

Source: https://payos.vn/docs/sdks/back-end/node

Initialize the PayOS instance with credentials from your payment channel.

```javascript
import { PayOS } from '@payos/node';

const payOS = new PayOS({
  clientId: process.env.PAYOS_CLIENT_ID,
  apiKey: process.env.PAYOS_API_KEY,
  checksumKey: process.env.PAYOS_CHECKSUM_KEY,
});
```

--------------------------------

### Initialize payOS Node.js Library

Source: https://payos.vn/docs/developer-program

Use this snippet to initialize the payOS client with your credentials and partner code.

```javascript
const PayOS = require('@payos/node');
const payos = new PayOS({
  clientId: 'YOUR_PAYOS_CLIENT_ID',
  apiKey: 'YOUR_PAYOS_API_KEY',
  checksumKey: 'YOUR_PAYOS_CHECKSUM_KEY',
  partnerCode: 'PARTNER_CODE',
});
```

--------------------------------

### GET /v2/payment-requests/{id}/invoices/{invoice-id}/download

Source: https://payos.vn/docs/api

Downloads the invoice file for a specific payment link.

```APIDOC
## GET /v2/payment-requests/{id}/invoices/{invoice-id}/download

### Description
API dùng để lấy tải hóa đơn của link thanh toán.

### Method
GET

### Endpoint
https://api-merchant.payos.vn/v2/payment-requests/{id}/invoices/{invoice-id}/download

### Parameters
#### Path Parameters
- **id** (number or string) - Required - Mã đơn hàng của cửa hàng hoặc mã link thanh toán của payOS
- **invoice-id** (string) - Required - Mã hóa đơn của link thanh toán

### Response
#### Success Response (200)
- Returns a PDF file content.
```

--------------------------------

### GET /v2/payment-requests/{id}

Source: https://payos.vn/docs/api

Retrieves the current information and status of a payment link using its unique identifier.

```APIDOC
## GET /v2/payment-requests/{id}

### Description
API used to retrieve information about a payment link.

### Method
GET

### Endpoint
https://api-merchant.payos.vn/v2/payment-requests/{id}

### Parameters
#### Path Parameters
- **id** (number or string) - Required - The store order code or the payOS payment link code.

### Response
#### Success Response (200)
- **code** (string) - Status code of the response.
- **desc** (string) - Description of the response status.
- **data** (object) - Payment link details including id, orderCode, amount, amountPaid, amountRemaining, status, createdAt, and transactions.
- **signature** (string) - Response signature for verification.

#### Response Example
{
  "code": "00",
  "desc": "success",
  "data": {
    "id": "124c33293c934a85be5b7f8761a27a07",
    "orderCode": 123,
    "amount": 10000,
    "amountPaid": 0,
    "amountRemaining": 10000,
    "status": "PENDING",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "transactions": { }
  },
  "signature": "bec38349957f1a6c22ded683d06477ac5dfe047cf5f23c70dc8e048759ef5678"
}
```
Tokens:
Raw