Bank

API lấy danh sách ngân hàng và cập nhật tài khoản ngân hàng trên Goship API

Bank API dùng để lấy danh sách ngân hàng hỗ trợ trên hệ thống và cập nhật thông tin tài khoản ngân hàng của bạn (dùng để nhận tiền COD).

Lấy danh sách ngân hàng

GET https://sandbox.goship.io/api/v2/banks

Response data:

{
  "code": 200,
  "status": "success",
  "data": [
    {
      "id": 1,
      "name": "Ngân hàng TMCP Ngoại thương Việt Nam",
      "short_name": "Vietcombank"
    },
    {
      "id": 2,
      "name": "Ngân hàng TMCP Công thương Việt Nam",
      "short_name": "Vietinbank"
    }
  ]
}

Trong đó:

  • id: Mã ngân hàng, dùng cho tham số bank_id khi cập nhật tài khoản ngân hàng
  • name: Tên đầy đủ của ngân hàng
  • short_name: Tên viết tắt của ngân hàng

Ghi chú: API lấy danh sách ngân hàng không có phân trang.

Cập nhật tài khoản ngân hàng

Cập nhật thông tin tài khoản ngân hàng của bạn. Mỗi lần cập nhật, hệ thống sẽ ghi lại lịch sử thay đổi.

PUT https://sandbox.goship.io/api/v2/account/update/bank

Request body:

{
  "bank_id": 1,
  "branch": "Chi nhánh Hà Nội",
  "owner": "Nguyễn Văn A",
  "number": "0011002233445"
}

Trong đó:

  • bank_id: Mã ngân hàng (lấy từ API danh sách ngân hàng phía trên)
  • branch: Chi nhánh
  • owner: Chủ tài khoản
  • number: Số tài khoản

Response data:

{
  "code": 200,
  "status": "success",
  "data": {
    "bank_id": 1,
    "name": "Ngân hàng TMCP Ngoại thương Việt Nam",
    "branch": "Chi nhánh Hà Nội",
    "owner": "Nguyễn Văn A",
    "number": "0011002233445"
  }
}

Error

Khi thiếu hoặc sai thông tin, hệ thống trả về lỗi 422:

{
  "code": 422,
  "status": "error",
  "data": {
    "errors": {
      "bank_id": ["Vui lòng chọn ngân hàng"],
      "branch": ["Vui lòng nhập chi nhánh"],
      "owner": ["Vui lòng nhập chủ tài khoản"],
      "number": ["Vui lòng nhập số tài khoản"]
    },
    "exception": "The given data failed to pass validation."
  },
  "message": "Unprocessable Entity"
}
Shipment status
Danh sách trạng thái và mã code tương ứng của response data từ hệ thống Goship API
Rate
Cách lấy biểu phí vận chuyển hoả tốc qua Goship API