API Tạo plan

Endpoint: /api/v1/subs/plans

Method: POST

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

Tham số

Tham số	Yêu cầu	Kiểu dữ liệu	Mô tả	Validate
partnerRefId	Required	String	Mã tham chiếu của Partner đối với AppotaPay (không được trùng lặp)	min:1, max: 50, format: alphanumeric
customerId	Required	String	Mã khách hàng
currency	Required	String	Đơn vị tiền tệ	in: VND
amount	Required	Integer	Số tiền thanh toán
paymentMethods	Required	Array	Danh sách payment method
paymentMethods.*.paymentMethodId	Required	String	Payment method ID
paymentMethods.*.rank	Required	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
immediateActionType	Optional	String	Thực hiện trừ tiền ngay thì tạo thành công plan, null: tiền trừ vào thời điểm anchorDate - FULL_AMOUNT: thực hiện trừ tiền khi khởi tạo plan thành công	in: FULL_AMOUNT
failedCycleAction	Required	String	Hành động khi cycle thực hiện thanh toán thất bại - STOP: Dừng toàn bộ plan - RESUME: Bỏ qua cycle thất bại và tiến hành cycle kế tiếp	in: STOP, RESUME
schedule	Required	Object	Cấu hình chu kỳ thanh toán định kỳ
schedule.interval	Required	String	Tần suất thực hiện thanh toán định kỳ	in: DAY, WEEK, MONTH
schedule.intervalCount	Required	Integer	Đơn vị khoảng thời gian giữa 2 chu kỳ liên tiếp	min: 1
schedule.totalRecurrence	Optional	Integer	Tổng số lần thanh toán định kỳ trong plan null: không giới hạn	min: 1
schedule.anchorDate	Optional	String	Thời điểm thực hiện thanh toán định kỳ Default: ngày khởi tạo plan thành công Giá trị hợp lệ: ngày từ 1-28 (của 1 tháng) Lưu ý: nếu anchorDate: null và thời điểm khởi tạo plan là ngày 29/30/31 của tháng, anchorDate mặc định sẽ lấy value là ngày 1 của tháng tiếp theo	format: ISO-8601
schedule.retryInterval	Optional	String	Tần suất thực hiện thanh toán lại trong 1 cycle nếu thanh toán xảy ra vấn đề	in: DAY
schedule.retryIntervalCount	Optional	Integer	Đơn vị khoảng thời gian giữa 2 lần thực hiện thanh toán lại	min:1
schedule.totalRetry	Optional	Integer	Tổng số lần thanh toán lại null: không thực hiện thanh toán lại	min:1, max: 10

Example Request

{
    "partnerRefId": "ASKJLKALK299",
    "customerId": "01HRVGAJSP7SX83X7AQ9QQYMBE",
    "currency": "VND",
    "amount": 85000,
    "paymentMethods": [
        {
            "paymentMethodId": "01HRVJY8ZMZFHRHE3KG2S24KKW",
            "rank": 1
        }
    ],
    "immediateActionType": "FULL_AMOUNT",
    "failedCycleAction": "STOP",
    "schedule": {
        "interval": "DAY",
        "intervalCount": 1,
        "totalRecurrence": 3,
        "anchorDate": "2024-01-13T15:23:40+07:00",
        "retryInterval": "DAY",
        "retryIntervalCount": 1,
        "totalRetry": 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": 1,
    "message": "Thông tin yêu cầu thiếu hoặc không hợp lệ",
    "errors": [
        {
            "field": "partnerRefId",
            "reason": "Trường mã tham chiếu giao dịch của đối tác không được bỏ trống."
        }
    ]
}

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
3002	Mã tham chiếu Partner đã bị trùng, vui lòng thực hiện lại
3003	Customer không tồn tại
3004	Payment method không tồn tại
3012	Payment method không hợp lệ