API Check bill information

Endpoint: /api/v1/service/bill/check

Method: POST

Header: How to generate JWT_TOKEN

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

Params

Params	Required	Type	Description
partnerRefId	√	String	This is unique code corresponding to a request send (This ref id will be used when call API payment bill)
billCode	√	String	Bill code/payment
serviceCode	√	String	Service code (see more Table Of Content List code service)
signature	√	String	Signature of parameter passed to the API, the parameter is included into signature like this: billCode + partnerRefId + serviceCode (see more how to generate signature)

Data result

Params	Type	Description
errorCode	Integer	Error code result
message	String	Description detail error code
billDetail	Array	Information bill detail
billDetail[].billNumber	String	Bill number ID
billDetail[].period	String	Period payment bill
billDetail[].amount	Integer	Bill amount
billDetail[].billCreated	String	Created time bill
billDetail[].billExpiry	String	Expired payment
billDetail[].billType	String	Bill type
billDetail[].billOtherInfo	String	Other information
billDetail[].isPartialPaymentAllowed	Boolean	Does the invoice allow partial payments? (default: false)
billDetail[].extraInfo	String	Extra information
customerInfo	Object	Customer information
customerInfo.customerCode	String	Customer code
customerInfo.customerName	String	Customer name
customerInfo.customerAddress	String	Customer address
customerInfo.customerOtherInfo	String	Other information
customerInfo.extraInfo	String	Extra information

Example

Request

{
    "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": ""
        }
    ],
    "customerInfo": {
        "customerCode": "PA12121",
        "customerName": "Nguyen Van A",
        "customerAddress": "Ha Noi",
        "customerOtherInfo": "PA11",
        "extraInfo": ""
    }
}