6.5. API lấy danh sách tài khoản định danh (VA)

Api lấy danh sách tài khoản định danh (VA)

API lấy danh sách VA

POST https://open-api.tingee.vn/v1/get-va-paging - Môi trường live

POST https://uat-open-api.tingee.vn/v1/get-va-paging - Môi trường test

Gửi lệnh lấy danh sách VA

Headers

Name	Type	Description
x-client-id	string	Định danh ứng dụng (Lấy trong https://app.tingee.vn/m/developers)
x-request-timestamp	string	Dấu thời gian (yyyyMMddHHmmssSSS)
x-signature	string	Quy tắc kiểm tra tính toàn vẹn dữ liệu: Chuỗi giá trị cần hash = {x-request-timestamp}:{request body convert về string} Sau đó thực hiện mã hóa chuỗi bên trên với giải thuật: HMAC SHA512 với Key là Secret token lấy tại mục Developers trên Tingee

Request Body

Name	Type	Description
filter	string	Từ khóa tìm kiếm
skipCount*	number	Số bản ghi bỏ qua
maxResultCount*	number	Số bản ghi của 1 trang
bankName	enum	Ngân hàng (OCB, BIDV, MBB, ACB và VPB), giá trị null sẽ lấy tất cả

200: OK

{
  "totalCount": 0, // Tổng bản ghi
  "items": [ //danh sách bản ghi của 1 trang
    {
      "bankName": "OCB",//Ngân hàng
      "bankBin": "970448",//Mã bin ngân hàng
      "accountType": "personal-account",//loại tài khoản
      "accountName": "string",//Chủ tài khoản
      "accountNumber": "string",//Số tài khoản
      "vaAccountNumber": "string",//Số tài khoản định danh
      "status": "inactive", //trạng thái
      "creationTime": "2024-07-18T02:46:05.724Z", //ngày tạo
    }
  ]
}

401: Unauthorized

{
  "message": "Unauthorized.",
  "error": "Unauthorized",
  "statusCode": 401
}

400: Bad Request

{
  "message": "Not have access.",
  "error": "Bad Request",
  "statusCode": 400
}

403: Forbidden

{
  "message": "Forbidden.",
  "error": "Forbidden",
  "statusCode": 403
}

404: Not Found

{
  "message": "Not Found.",
  "error": "Not Found",
  "statusCode": 404
}

500: Internal Server Error

{
  "message": "Internal Server Error.",
  "error": "Internal Server Error",
  "statusCode": 500
}

501: Not Implemented

{
  "message": "Not Implemented.",
  "error": "Not Implemented",
  "statusCode": 501
}

Ví dụ CURL:

curl --location 'https://open-api.tingee.vn/v1/get-va-paging' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'x-request-timestamp: 20240524155831608' \
--header 'x-client-id: f4ba500b1f5798399907cd7ba41d368c' \
--header 'x-signature: e8547f7a75659319487894454e2eef005f20d7bcb391713f46ca6a574c5585d6a663e01afd6feb7a56291e5a95b93cadbc5f89413729110f7868c58788c4a219' \
--data '{
  "filter": "",
  "skipCount": 0,
  "maxResultCount": 0,
  "bankName": "OCB",
}'