Skip to main content
Version: 1.0

Check transaction status

Check transaction status API#

Endpoint: /api/v1/orders/transaction/bank/status

Method: POST

Header: How to generate JWT_TOKEN

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

HTTP Request:

ParamsSample
orderId5f5b46cb73fd0
signature3d4cf0f6130ee51f75714733922a7e76b1c18704187827a78abd379f4ab266ec

HTTP Response:

ParamsData typeDescription
errorCodeIntegerError Code
messageStringError detail
partnerCodeStringPartner Code
apiKeyStringPartner APIKEY
amountIntegerPayment amount
currencyStringCurrency code (default: VND)
orderIdStringOrder ID
bankCodeStringBank code
paymentMethodStringPayment method
paymentTypeStringPayment type (default: WEB)
appotapayTransIdStringAppotaPay transaction ID
transactionTsIntegerTransaction time
extraDataStringExtra data
cardInfoObjectCard information
cardInfo.cardNumberStringCard number
cardInfo.cardDateStringCard date
cardInfo.cardNameStringCard name
cardInfo.countryCodeStringCountry code
signatureStringSignature check data

signature = HMAC_SHA256(data, secretKey)

data: amount={amount}&apiKey={apiKey}&appotapayTransId={appotapayTransId}&bankCode={bankCode}& currency={currency}&errorCode={errorCode}&extraData={extraData}&message={message}&orderId={orderId}&partnerCode={partnerCode}&paymentMethod={paymentMethod}&paymentType={paymentType}&transactionTs={transactionTs}

Example Response#

{    "errorCode":0,    "message":"Thành công",    "partnerCode": "TEST",    "apiKey": "oMhJpkz7K6HDcR6S",    "amount":50000,    "currency":"VND",    "orderId":"5f5b46cb73fd0",    "bankCode":"SHB",    "paymentMethod":"ATM",    "paymentType":"WEB",    "appotapayTransId":"AP200910014125B",    "transactionTs":1599817433,    "extraData":"test test",    "signature":"d6ff2d38c2b1167c6d17b9dbb1380347b24c1bf912dc442dbd018b2e1ed74f3d",    "cardInfo":{        "cardNumber":"",        "cardDate":"",        "cardName":"",        "countryCode":""     }}