API Huỷ Thanh Toán

EndPoint

POST /api/v2/ewallet/transaction/cancel

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
X-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": "Bearer JWT_TOKEN",
  "Content-Type": "application/json",
  "X-Request-ID": "Your_Unique_id",
  "X-Language": "vi",
  "X-Account-Ref-ID": "9723f73b-9295-4acb-884b-ab6310c2e653"
}

Request Params

Tham số	Yêu cầu	Kiểu dữ liệu	Mô tả	Lưu ý
orderId	required	String	Mã đơn hàng phía đối tác
signature	required	String	Chữ ký kiểm tra dữ liệu	signature = hash_hmac('sha256', 'orderId={orderId}&verificationCode={verificationCode}' , SECRET_KEY)

Example Request

{
  "orderId": "241698338917842945",
  "signature": "8d969eef6ecad3c29a3a629280e686cf0c3f5d5a86aff3ca12020c923adc6c92"
}

Response Params

Thành công

Http Status Code 200 - OK

Tham số	Kiểu dữ liệu	Mô tả
transactionId	String	Mã giao dịch phía AppotaPay
orderId	Integer	Mã đơn hàng phía đối tác

Thất bại

HTTP Status Code != 200

Tham số	Kiểu dữ liệu	Mô tả
errorCode	Integer	Mã lỗi
message	String	Mô tả thêm về lỗ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ả
1	Thông tin yêu cầu thiếu hoặc không hợp lệ
2	Tham số signature không chính xác
21	Mã OTP không đúng
22	Mã OTP đã hết hạn xác thực, vui lòng thực hiện lại giao dịch
30	Mã đơn hàng đã bị trùng, vui lòng thực hiện lại giao dịch
32	Số tiền thanh toán không hợp lệ
33	Giao dịch thất bại
34	Giao dịch đang được xử lý, vui lòng kiểm tra lại sau
36	Giao dịch không tồn tại
39	Người dùng nhập sai mã OTP quá số lần quy định
40	Giao dịch đã được hoàn trả
41	Giao dịch đã thành công trước đó
42	Yêu cầu lấy mã OTP quá số lần quy định
52	Phương thức thanh toán không hợp lệ
65	Tài khoản không hợp lệ
70	Bạn đã giao dịch vượt quá giới hạn trong ngày, vui lòng thử lại sau
75	Số tiền không đủ để thanh toán
84	Số tiền giao dịch quá giới hạn cho phép, vui lòng liên hệ để được hỗ trợ
93	Quá thời gian hoàn tiền giao dịch
94	Hệ thống đang bảo trì, vui lòng thử lại sau
99	Lỗi không xác định, vui lòng kiểm tra lại giao dịch sau
106	Giao dịch không hỗ trợ refund một phần
125	Không thể hoàn tiền cho giao dịch vì đã quá thời hạn hoàn tiền
162	Bạn đã giao dịch vượt quá giới hạn trong tháng, vui lòng thử lại sau
401	Lỗi xác thực
500	Hệ thống gặp lỗi, vui lòng thử lại sau

Ví dụ Code

curl --location 'https://gateway.dev.appotapay.com/api/v2/ewallet/transaction/cancel' \
  --header 'X-APPOTAPAY-AUTH: JWT_TOKEN' \
  --header 'Content-Type: application/json' \
  --header 'X-Request-ID: Your_Unique_id' \
  --header 'X-Language: vi' \
  --header 'X-Account-Ref-ID: 9723f73b-9295-4acb-884b-ab6310c2e653' \
  -d '{
  "orderId": "241698338917842945",
  "signature": "8d969eef6ecad3c29a3a629280e686cf0c3f5d5a86aff3ca12020c923adc6c92"
}'

Request

REQUEST

Base URL

https://gateway.dev.appotapay.com

Development server

Path

Auth REQUIRED

Bearer Token

X-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

Body REQUIRED

Example (from schema)

{ "orderId": "241698338917842945", "signature": "8d969eef6ecad3c29a3a629280e686cf0c3f5d5a86aff3ca12020c923adc6c92" }