Phiên bản: Lastest

API Cập nhật cycle

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

Method: PATCH

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-APPOTAPAY-AUTH": "JWT_TOKEN",
    "Content-Type": "application/json",
    "X-Request-ID": "Your_Unique_id",
    "Language": "vi"
}

Tham số	Yêu cầu	Kiểu dữ liệu	Mô tả
scheduledAt	Optional	String	Thời gian dự kiến thanh toán (định dạng chuẩn ISO-8601)
currency	Optional	Integer	Đơn vị tiền tệ
amount	Optional	Integer	Số tiền thanh toán

| format ISO 3166-2 Country Code |

{
    "scheduledAt": "2024-01-31T10:21:05+07:00",
    "currency": "VND",
    "amount": 405100
}

Http Status Code 200 - OK

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

HTTP Status Code != 200

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": 3008,
    "message": "Cycle not exist"
}

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
3005	Plan không tồn tại
3008	Cycle không tồn tại
3017	Thời gian dự kiến thanh toán không hợp lệ
3047	Không thể cập nhật cycle. Chỉ cập nhật cycle ở trạng thái SCHEDULED