API Nạp tiền điện thoại
Endpoint: /api/v1/service/topup/charging
Method: POST
Header: Cách tạo JWT_TOKEN
{
"X-APPOTAPAY-AUTH": Bearer JWT_TOKEN,
"Content-Type": "application/json"
}
Tham số
Tham số | Yêu cầu | Kiểu dữ liệu | Mô tả |
---|---|---|---|
partnerRefId | √ | String | Mã giao dịch phía đối tác, duy nhất cho mỗi giao dịch |
telco | √ | String | Tên nhà mạng (xem thêm phần Phụ Lục bảng nhà mạng) |
telcoServiceType | √ | String | Loại dịch vụ (xem thêm phần Phụ Lục bảng mã dịch vụ) |
phoneNumber | √ | String | Số điện thoại nạp tiền (truyền dạng: 09x, 08x,..) |
amount | √ | Integer | Số tiền nạp |
signature | √ | String | Chữ ký các tham số truyền lên API, các tham số được đưa vào chữ ký theo thứ tự bao gồm: amount + partnerRefId + phoneNumber + telco + telcoServiceType (xem thêm phần cách tạo signature) |
Dữ liệu trả về
Tham số | Kiểu dữ liệu | Mô tả |
---|---|---|
errorCode | Integer | Mã lỗi trả về |
message | String | Mô tả chi tiết mã lỗi |
transaction | Object | Thông tin giao dịch |
transaction.amount | Integer | Số tiền giao dịch |
transaction.topupAmount | String | Số tiền nạp |
transaction.phoneNumber | String | Số điện thoại nạp |
transaction.appotapayTransId | String | Mã giao dịch phía AppotaPay |
transaction.time | String | Thời gian giao dịch |
account | Object | Thông tin tài khoản |
account.balance | Integer | Số dư tài khoản sau giao dịch |
signature | String | Chữ ký thông tin giao dịch trả về, các trường được ký bao gồm (amount + appotapayTransId + errorCode + phoneNumber + time + topupAmount) |
Ví dụ
Request
{
"partnerRefId": "AB123",
"telco": "viettel",
"telcoServiceType": "prepaid",
"phoneNumber": "0986868686",
"amount": 100000,
"signature": "b10294bae53e89919b3efd62a763bf3..."
}
Response
{
"errorCode": 0,
"message": "Thành công",
"transaction": {
"amount": 100000,
"topupAmount": 100000,
"appotapayTransId": "AP12adf21121",
"phonenumber": "0986868686",
"time": "10-04-2020 10:10:10",
},
"account": {
"balance": "121000000"
}
}