API Cập nhật plan

Endpoint: /api/v1/subs/plans/{planId}

Method: PATCH

Header Params

Tham số	Yêu cầu	Kiểu dữ liệu	Mô tả	Lưu ý
X-APPOTAPAY-AUTH	required	String	Cách tạo JWT_TOKEN
Content-Type	required	String	Giá trị: application/json
X-Request-ID	optional	String	Định dạng UUIDv4. Request ID để kiểm tra yêu cầu khi xảy ra sự cố	max:42
Language	optional	String	Giá trị vi hoặc en tương ứng với link thanh toán sẽ là tiếng việt hoặc tiếng anh, (mặc định: vi)	in:vi,en
X-Account-Ref-ID	optional	String	Mã định danh của tài khoản Sub account do AppotaPay cung cấp. Bắt buộc truyền khi thanh toán giao dịch của Sub account loại owner

{
    "X-APPOTAPAY-AUTH": "JWT_TOKEN",
    "Content-Type": "application/json",
    "X-Request-ID": "Your_Unique_id",
    "Language": "vi",
    "X-Account-Ref-ID": "9723f73b-9295-4acb-884b-ab6310c2e653"
}

Tham số

Tham số	Yêu cầu	Kiểu dữ liệu	Mô tả	Validate
customerId	Optional	String	Customer ID	min:1, max: 50
currency	Optional	String	Đơn vị tiền tệ	in: VND
amount	Optional	Integer	Số tiền thanh toán	min: 5000, max: 100000000
paymentMethods	Optional	Array	Danh sách payment method
paymentMethods.*.paymentMethodId	Optional	String	Payment method ID
paymentMethods.*.rank	Optional	Integer	Thứ tự ưu tiên phương thức thanh toán sẽ được sử dụng trong chu kỳ thanh toán	min: 1
currencyExchange	Optional	Object
currencyExchange.amount	Optional	Number	Số tiền quy đổi Hỗ trợ 2 số thập phân, ví dụ: 12.02	min: 0.10, max: 9999999999
currencyExchange.currency	Optional	String	Đơn vị tiền tệ chuyển đổi Hỗ trợ: USD

Example Request

{
    "customerId": "01HRVK3A0G66QJB16W2R1G2HSJ",
    "currency": "VND",
    "amount": 405100,
    "paymentMethods": [
        {
            "paymentMethodId": "f19bbadb-3446-4558-84c2-3c36a6b9757a",
            "rank": 1
        }
    ]
}

Dữ liệu trả về

Thành công

Http Status Code 200 - OK

Dữ liệu trả về thành công sẽ chứa một Plan object

Thất bại

HTTP Status Code != 200

Error response params

Tham số	Yêu cầu	Kiểu dữ liệu	Mô tả
errorCode	required	Integer	Mã lỗi
message	required	String	Mô tả lỗi
errors	optional	Array	Mô tả lỗi chi tiết các trường nếu có
errors.*.field	optional	String	Trường dữ liệu bị lỗi
errors.*.reason	optional	String	Mô tả trường dữ liệu bị lỗi

{
    "errorCode": 3005,
    "message": "Plan không tồn tại"
}

Bảng mã lỗi thường gặp

Mã lỗi đầy đủ vui lòng xem tại đây

Mã lỗi	Mô tả
0	Thành công
1	Thông tin yêu cầu thiếu hoặc không hợp lệ
11	Partner không tồn tại
13	Partner đã bị khoá
14	API Key không tồn tại
15	API Key chưa được kích hoạt hoặc đã bị khoá
92	IP không được phép truy cập
99	Lỗi không xác định, vui lòng liên hệ AppotaPay để biết thêm thông tin chi tiết
401	Lỗi xác thực
500	Hệ thống gặp lỗi, vui lòng thử lại sau
3003	Customer không tồn tại
3004	Payment method không tồn tại
3005	Plan không tồn tại
3006	Plan đã inactive trước đó
3012	Payment method không hợp lệ
3046	Plan đang chờ xử lý, vui lòng kiểm tra lại sau

Code Examples

curl -X PATCH "https://gateway.dev.appotapay.com/api/v1/subs/plans/01HRVGAJSP7SX83X7AQ9QQYMBE" \
  -H "X-APPOTAPAY-AUTH: JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -H "X-Request-ID: Your_Unique_id" \
  -H "Language: vi" \
  -H "X-Account-Ref-ID: 9723f73b-9295-4acb-884b-ab6310c2e653" \
  -d '{
  "customerId": "01HRVK3A0G66QJB16W2R1G2HSJ",
  "currency": "VND",
  "amount": 405100,
  "paymentMethods": [
    {
      "paymentMethodId": "f19bbadb-3446-4558-84c2-3c36a6b9757a",
      "rank": 1
    }
  ]
}'

Request

REQUEST

Base URL

https://gateway.dev.appotapay.com

Development server

Path

Auth REQUIRED

Bearer Token

Language — header

vien

Giá trị tương ứng với payment link có thể là tiếng Việt hoặc tiếng Anh (mặc định: vi)

Parameters

planId — path REQUIRED

Body REQUIRED

Example (from schema)

{ "customerId": "01HRVK3A0G66QJB16W2R1G2HSJ", "currency": "VND", "amount": 405100, "paymentMethods": [ { "paymentMethodId": "f19bbadb-3446-4558-84c2-3c36a6b9757a", "rank": 1 } ] }