Nhảy tới nội dung

Danh sách API

payOS API

Danh sách các API payOS hỗ trợ.

Trước khi bắt đầu

Môi trường

Đăng ký chương trình đối tác tích hợp payOS Tại đây

Tạo link thanh toán

API dùng để tạo link thanh toán đơn hàng

Authorizations:
(x-client-idx-api-key)
header Parameters
x-partner-code
string

Partner Code tham gia chương trình tích hợp đối tác payOS Tại đây

Request Body schema: application/json
orderCode
required
integer

Mã đơn hàng

amount
required
integer

Số tiền thanh toán

description
required
string

Mô tả thanh toán, với tài khoản ngân hàng không phải liên kết qua payOS thì giới hạn ký tự là 9

buyerName
string

Tên của người mua hàng. Thông tin dùng trong trường hợp tích hợp tạo hoá đơn điện tử.

buyerEmail
string

Email của người mua hàng. Thông tin dùng trong trường hợp tích hợp tạo hoá đơn điện tử.

buyerPhone
string

Số điện thoại người mua hàng. Thông tin dùng trong trường hợp tích hợp tạo hoá đơn điện tử.

buyerAddress
string

Địa chỉ của người mua hàng. Thông tin dùng trong trường hợp tích hợp tạo hoá đơn điện tử.

Array of objects

Danh sách các sản phẩm thanh toán

cancelUrl
required
string

URL nhận dữ liệu khi người dùng chọn Huỷ đơn hàng.

returnUrl
required
string

URL nhận dữ liệu khi đơn hàng thanh toán thành công

expiredAt
number

Thời gian hết hạn của link thanh toán, là Unix Timestamp và kiểu Int32

signature
required
string

Chữ ký kiểm tra thông tin không bị thay đổi trong qua trình chuyển dữ liệu từ hệ thống của bạn sang payOS. Bạn cần dùng checksum key từ Kênh thanh toán và HMAC_SHA256 để tạo signature và data theo định dạng được sort theo alphabet: amount=$amount&cancelUrl=$cancelUrl&description=$description&orderCode=$orderCode&returnUrl=$returnUrl.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json

Success - Thành công

{
}

Lấy thông tin link thanh toán

API dùng để lấy thông tin của link thanh toán

Lưu ý: Hiện tại thông tin tài khoản đối ứng trong các trường counterAccount chỉ được hỗ trợ bởi các ngân hàng sau:

  • MB Bank
  • ACB
  • KienlongBank
Authorizations:
(x-client-idx-api-key)
path Parameters
id
required
number or string
Example: 3019

Mã đơn hàng của cửa hàng hoặc mã link thanh toán của payOS

Responses

Response samples

Content type
application/json

Success - Thành công

{
}

Huỷ link thanh toán

API dùng để hủy link thanh toán

Authorizations:
(x-client-idx-api-key)
path Parameters
id
required
number or string
Example: 3019

Mã đơn hàng của cửa hàng hoặc mã link thanh toán của payOS

Request Body schema: application/json
cancellationReason
string

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json

Success - Thành công

{
}

Kiểm tra và thêm hoặc cập nhật Webhook url

API dùng để xác thực webhook url của một kênh thanh toán đồng thời thêm hoặc cập nhật webhook url cho Kênh thanh toán đó nếu thành công.

Authorizations:
(x-client-idx-api-key)
Request Body schema: application/json
webhookUrl
required
string

Đường dẫn webhook nhận dữ liệu ngân hàng từ payOS của bạn, lưu ý: payOS.vn sẽ gửi một dữ liệu mẫu kèm thông tin giao dịch ngân hàng mẫu để kiểm tra xem webhook có hoạt động hay không, dùng "signature" được mã hóa bằng HMAC_SHA256 để check xem cách tạo tại đây

Responses

Request samples

Content type
application/json

Response samples

Content type
application/json

Success - Thành công

{
}