Phiên bản: Lastest

API gạch thẻ

Endpoint: /v1/services/card_charging?api_key=YOUR_API_KEY

Method: POST

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

Tham số

Tham số	Yêu cầu	Kiểu dữ liệu	Mô tả
code	√	String	Mã thẻ ở dạng mã hoá
serial	√	String	Seri thẻ (12 ký tự)
vendor	√	String	để mặc định là: appota
partner_code	√	String	Mã Partner code nhận được từ phía AppotaPay cung cấp
service_name	√	String	Mã dịch vụ mà phía đối tác đã đăng ký
transaction_id	√	String	Mã giao dịch phía đối tác sinh ra, duy nhất cho mỗi giao dịch (từ 5 - 50 kí tự)
signature	√	String	Thông tin hash các params gửi sang API (signature= SHA256(code + serial + vendor + partner_code + service_name + transaction_id + secret_key)) Secret key phía AppotaPay cung cấp

Dữ liệu trả về

Tham số	Kiểu dữ liệu	Mô tả
error_code	String	Mã lỗi
message	String	Mô tả chi tiết mã lỗi
data	Object	Mô tả chi tiết giao dịch khi thành công
data.amount	Integer	Mệnh giá thẻ
data.serial	String	Seri thẻ
data.transaction_id	String	Mã giao dịch phía AppotaPay
data.time	String	Thời gian giao dịch

Ví dụ

Response

{
    "error_code": "00",
    "message": "Transaction success",
    "data": {
        "amount": 100000,
        "serial": "OTA123456789",
        "transaction_id": "abc123",
        "time": "10:05:01 08/05/2019 GMT+7"
    }
}

Ví dụ Code

curl -X POST "https://gateway.dev.appotapay.com/v1/services/card_charging?api_key=YOUR_API_KEY" \
  -H "X-APPOTAPAY-AUTH: JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "encrypted_card_code",
  "serial": "OTA123456789",
  "vendor": "appota",
  "partner_code": "PARTNER_CODE",
  "service_name": "TEST",
  "transaction_id": "unique_transaction_id_12345",
  "signature": "calculated_signature_hash"
}'

Request

REQUEST

Base URL

Development server

Path

Auth REQUIRED

Bearer Token

Parameters

api_key — query REQUIRED

Body REQUIRED

Example (from schema)

Tham số​

Dữ liệu trả về​

Ví dụ​

Response​

Ví dụ Code​

Request​