Skip to main content
Version: 1.0

Check status transaction

API used to check status transaction

API check status transaction

Endpoint: /api/v1/service/bill/transaction/{partnerRefId}

Method: GET

Header: How to generate JWT_TOKEN

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

Params

ParamsRequiredTypeDescription
partnerRefIdStringTransaction id from partner send to API url

Data result

ParamsTypeDescription
errorCodeIntegerError code
messageStringDescription detail error code
billDetailArrayJSON String is array information bill is result from API check bill
billDetail[].billNumberStringBill ID
billDetail[].periodStringPeriod payment bill
billDetail[].amountIntegerMoney bill
billDetail[].billCreatedStringCreated time bill
billDetail[].billExpiryStringExpiry payment
billDetail[].billTypeStringBill type
billDetail[].billOtherInfoStringBill other information
billDetail[].isPartialPaymentAllowedBoolDoes the invoice allow partial payments? (default: false)
billDetail[].extraInfoStringExtra information
transactionObjectTransaction information
transaction.appotapayTransIdStringTransaction id from AppotaPay
transaction.amountIntegerMoney transaction
transaction.billAmountIntegerMoney to bill
transaction.timeStringTime transaction
signatureStringSignature of parameter passed to the API, the parameter is included into signature like this (amount + appotapayTransId + billAmount + errorCode + time)

Example

Response

{
"errorCode": 0,
"message": "Success",
"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"
},
"signature": "b10294bae53e89919b3efd62a763bf3228e260ef1a329..."
}