Nhảy tới nội dung
Phiên bản: 1.0

API Thanh toán hoá đơn

Endpoint: /api/v1/service/bill/pay

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ầuKiểu dữ liệuMô tả
partnerRefIdStringMã giao dịch mà đã gửi ở API truy vấn thông tin hoá đơn
billCodeStringMã hoá đơn/thanh toán
serviceCodeStringMã dịch vụ (xem thêm phần Phụ Lục bảng mã dịch vụ)
amountIntegerSố tiền thanh toán
billDetailStringJSON String của mảng thông tin hoá đơn đã trả về từ API truy vấn hoá đơn
signatureStringChữ ký các tham số truyền lên API, các tham số được đưa vào chữ ký bao gồm: amount + billCode + billDetail + partnerRefId + serviceCode (xem thêm phần cách tạo signature)

Dữ liệu trả về

Tham sốKiểu dữ liệuMô tả
errorCodeIntegerMã lỗi trả về
messageStringMô tả chi tiết mã lỗi
billDetailArrayMảng thông tin chi tiết hoá đơn
billDetail[].billNumberStringID của hoá đơn
billDetail[].periodStringKỳ thanh toán hoá đơn
billDetail[].amountIntegerSố tiền hoá đơn
billDetail[].billCreatedStringNgày tạo hoá đơn
billDetail[].billExpiryStringNgày hết hạn thanh toán
billDetail[].billTypeStringLoại hoá đơn
billDetail[].billOtherInfoStringCác thông tin khác
billDetail[].isPartialPaymentAllowedBoolHoá đơn có cho phép thanh toán từng phần hay không (mặc định: false)
billDetail[].extraInfoStringThông tin bổ sung
transactionObjectThông tin giao dịch
transaction.appotapayTransIdStringMã giao dịch phía AppotaPay
transaction.amountIntegerSố tiền giao dịch
transaction.billAmountIntegerSố tiền hoá đơn thanh toán
transaction.timeStringThời gian giao dịch
accountObjectThông tin tài khoản
account.balanceIntegerSố dư tài khoản sau giao dịch
signatureStringChữ ký thông tin giao dịch trả về, các trường được ký bao gồm (amount + appotapayTransId + billAmount + errorCode + time)

Ví dụ

Request

{
"amount": 100000,
"billDetail": [
{
"billNumber": "117934",
"period": "4/2020",
"amount": 100000,
"billCreated": "",
"billExpiry": "",
"billType": "",
"billOtherInfo": "",
"isPartialPaymentAllowed": false,
"extraInfo": ""
}
],
"partnerRefId": "AB123",
"billCode": "PD12121",
"serviceCode": "ENVHN",
"signature": "b10294bae53e89919b3efd62a763bf3..."
}

Response

{
"errorCode": 0,
"message": "Thành công",
"billDetail": [
{
"billNumber": "117934",
"period": "4/2020",
"amount": 100000,
"billCreated": "",
"billExpiry": "",
"billType": "",
"billOtherInfo": "",
"isPartialPaymentAllowed": false,
"extraInfo": ""
}
],
"transaction": {
"amount": 100000,
"billAmount":100000,
"appotapayTransId": "01ARXAAWEBDS",
"time": "10-04-2020 10:10:10"
},
"account": {
"balance": 12200000
},
"signature": "b10294bae53e89919b3efd62a763bf3228e260ef1a329..."
}