Skip to main content
Version: 1.0

API Get detail ebill

Endpoint: /api/v1/service/ebill/detail/{billCode}

Method: GET

Header: How to generate JWT_TOKEN

{
"X-APPOTAPAY-AUTH": Bearer JWT_TOKEN,
"Content-Type": "application/json"
}

Params

ParamsRequiredTypeDescription
billCodeStringPartner BillCode

Data result

ParamsTypeDescription
errorCodeIntegerError code result
messageStringDescription error code detail
billCodeStringBill code, is the unique code for each order
amountIntegerBill amount
paidAmountIntegerPaid amount
billExpiryTimeIntegerExpiry time to payment
paymentObjectPayment information user paid
payment.bankAccountsArray of ObjectBank account
payment.bankAccounts.bankCodeStringBank code
payment.bankAccounts.bankNameStringBank name
payment.bankAccounts.accountNoStringAccount number
payment.bankAccounts.accountNameStringAccount name
payment.bankAccounts.bankBranchStringBank branch
payment.bankAccounts.statusStringBank account status

active: bank account is active

inactive: bank account is temporary inactive

closed: bank account is closed

signatureStringSignature of parameter passed to the API, the parameter is included into signature like this: amount + billCode + billExpiryTime + errorCode + paidAmount + json_encode(payment) (more how to generate signature)

Example

Response

{
"errorCode": 0,
"message": "Thành công",
"billCode":"605823cdc67f4",
"amount":50000,
"paidAmount":0,
"billExpiryTime":1616818154,
"payment": {
"bankAccounts": [{
"bankCode": "WOORIBANK",
"bankName": "WOORIBANK",
"accountNo": "902000225811",
"accountName": "VAP001 PHAM MINH TUAN",
"bankBranch": "",
"status": "active"
}]
},
"signature": "73c600b139fcd08eecf811d1c5869504d039f1ed8b320ede614ab0 9469c4a44b"
}