Balance Notification API

This API is called from the payment system to send balance notifications to the speaker device. The device will announce the corresponding amount aloud.

API Endpoint

POST

https://speaker-api.sepay.vn/devices/v1/speaker/transactions/notify

Request Parameters

hardwareIdstringrequired

Device serial number

amountintegerrequired

Balance change amount (VND)

requestIdstringrequired

Unique transaction or request ID

Note

requestId must be unique for each transaction to prevent duplicates (idempotency)
The device will announce the corresponding amount aloud
The device must be paired and currently online

Code Examples

curl --request POST \
  --url https://speaker-api.sepay.vn/devices/v1/speaker/transactions/notify \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"hardwareId":"VNS52508000001","amount":150000,"requestId":"TXN202510130001"}'

API Response

Response 200 - Sent successfully

{
  "code": 200,
  "message": "Đã gửi thông báo thành công",
  "data": {
    "hardwareId": "VNS52508000001",
    "requestId": "TXN202510130001",
    "status": "SENT"
  }
}

codeinteger

Response code (200 on success)

messagestring

Result description

dataobject