Kiểm tra giao dịch hoàn tiền
Endpoint: GET
/api/v2/transaction/refund/{refundRefId}
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:40 |
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-APPOTAPAY-AUTH": "JWT_TOKEN",
"Content-Type": "application/json",
"X-Request-ID": "Your_Unique_id",
"X-Language": "vi"
}
URL params
Tham số | Yêu cầu | Kiểu dữ liệu | Mô tả |
---|---|---|---|
refundRefId | required | String | Mã tham chiếu giao dịch hoàn tiền |
Query params
Tham số | Yêu cầu | Kiểu dữ liệu | Mô tả |
---|---|---|---|
type | optional | String | Loại tham chiếu giao dịch
Mặc định là: |
Dữ liệu trả về
Tham số | Yêu cầu | Kiểu dữ liệu | Mô tả |
---|---|---|---|
refundId | required | String | Mã giao dịch hoàn tiền phía AppotaPay |
transactionId | required | String | Mã giao dịch thanh toán phía AppotaPay |
partnerRefId | required | String | Mã tham chiếu giao dịch hoàn tiền phía đối tác |
amount | required | Integer | Số tiền hoàn |
currency | required | String | Đơn vị tiền tệ (chấp nhận VND) |
reason | required | String | Lý do hoàn tiền |
status | required | String | Trạng thái hoàn tiền |
createdAt | required | String | Thời gian thực hiện giao dịch |
refundedAt | optional | String | Thời gian thực hoàn tiền nếu giao dịch hoàn tiền thành công |
Ví dụ
Request
Response
Error
{
"errorCode": 1,
"message": "Invalid Params"
}
Bảng mã lỗi
Mã lỗi | Mô tả |
---|---|
1 | Thông tin yêu cầu thiếu hoặc không hợp lệ |
36 | Giao dịch không tồn tại |
401 | Unauthorized |