API chỉnh sửa Công ty

POST /company/edit/{id}: chỉnh sửa thông tin công ty SePay Bank Hub gồm tên, trạng thái và số lượt giao dịch nhận thông báo qua partial update đã xác thực.

||

API Endpoint

POST
https://bankhub-api.sepay.vn/v1/company/edit/{company_id}

Path Parameters

company_idstringrequired

ID của công ty cần chỉnh sửa

Request Body

full_namestring

Tên đầy đủ của công ty

short_namestring

Tên viết tắt

statusenum

Trạng thái công ty

payment_codeenum

Bật/tắt nhận diện mã thanh toán

payment_code_prefixstring

Tiền tố mã thanh toán (2-5 ký tự chữ cái)

payment_code_suffix_frominteger

Độ dài tối thiểu hậu tố

payment_code_suffix_tointeger

Độ dài tối đa hậu tố

payment_code_suffix_character_typeenum

Loại ký tự hậu tố

transaction_amountobject

Số lượt giao dịch còn được gửi thông báo (mỗi giao dịch tiền vào được gửi thông báo thì trừ 1, về 0 thì ngừng gửi), hoặc "Unlimited"

Lưu ý
  • API này yêu cầu Bearer Token trong header Authorization
  • Hỗ trợ partial update - chỉ gửi các trường cần thay đổi

Xử lý lỗi

404Not Found

Công ty không tồn tại hoặc không thuộc merchant này

401Unauthorized

Access token không hợp lệ hoặc đã hết hạn

400Validation Error

Dữ liệu đầu vào không hợp lệ

API Response

Response 200 - Cập nhật thành công
{
  "code": 200,
  "message": "Đã cập nhật thông tin công ty (tổ chức) thành công."
}
codeinteger
messagestring
Response 404 - Không tìm thấy
{
  "code": 0,
  "message": "string",
  "status": 0,
  "error": "string"
}

Code mẫu

>
>
>
>
>
curl --request POST \
  --url https://bankhub-api.sepay.vn/v1/company/edit/d3dafd01-e06b-11f0-b29e-52c7e9b4f41b \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"full_name":"string","short_name":"string","status":"Pending","payment_code":"on","payment_code_prefix":"string","payment_code_suffix_from":1,"payment_code_suffix_to":1,"payment_code_suffix_character_type":"NumberOnly","transaction_amount":null}'

Ví dụ sử dụng

JSCập nhật tên công ty
1
2
3
4
5
6
curl --location --request POST 'https://bankhub-api.sepay.vn/v1/company/edit/d3dafd01-e06b-11f0-b29e-52c7e9b4f41b' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--data '{
  "full_name": "Công ty TNHH ABC Updated"
}'
JSThay đổi trạng thái công ty thành Pending
1
2
3
4
5
6
curl --location --request POST 'https://bankhub-api.sepay.vn/v1/company/edit/d3dafd01-e06b-11f0-b29e-52c7e9b4f41b' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--data '{
  "status": "Pending"
}'
JSCập nhật số lượt giao dịch nhận thông báo
1
2
3
4
5
6
curl --location --request POST 'https://bankhub-api.sepay.vn/v1/company/edit/d3dafd01-e06b-11f0-b29e-52c7e9b4f41b' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--data '{
  "transaction_amount": "1000"
}'
Lưu ý quan trọng
  • Chỉ gửi các trường cần thay đổi (partial update).
  • Trường gửi lên vẫn phải đúng quy tắc validation: tên tối thiểu 3 ký tự, status đúng định dạng.
  • Kiểm tra company_id trước khi cập nhật để tránh lỗi 404.
  • transaction_amount là số lượt giao dịch còn được gửi thông báo, không phải hạn mức số tiền: mỗi giao dịch tiền vào được gửi thông báo thì trừ 1, về 0 thì ngừng gửi. Gửi số nguyên không âm dạng chuỗi, hoặc "Unlimited" để không giới hạn. Giá trị gửi lên thay hẳn số lượt đang còn, không cộng thêm: còn 200 lượt mà gửi "1000" thì số lượt mới là 1000.
Trước
—
Tiếp theo
—