Company Detail API

API to retrieve detailed information for a specific company by company_id. Returns full details including the company's configuration and status.

API Endpoint

GET

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

Path Parameters

company_idstringrequired

Company ID (xid format)

Note

This API requires a Bearer Token in the Authorization header
The configuration field contains company-specific configurations (if any)

Error Handling

404Not Found

The company (organization) does not exist or does not belong to this merchant

401Unauthorized

The access token is invalid or has expired

API Response

Response 200 - Success

{
  "data": {
    "xid": "string",
    "full_name": "string",
    "status": "string",
    "active": "string",
    "configuration": {
      "payment_code": "string",
      "payment_code_prefix": "string",
      "payment_code_suffix_from": 0,
      "payment_code_suffix_to": 0,
      "payment_code_suffix_character_type": "string",
      "data_storage_time": "string",
      "transaction_amount": "string"
    },
    "created_at": "string",
    "updated_at": "string"
  }
}

dataobject

Company detail information

Response 404 - Not Found

{
  "code": 0,
  "message": "string",
  "status": 0,
  "error": "string"
}

Code Examples

curl --request GET \
  --url https://bankhub-api-sandbox.sepay.vn/v1/company/d3dafd01-e06b-11f0-b29e-52c7e9b4f41b \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Handling 404 Errors

A 404 error may occur when:
- The Company ID does not exist in the system
- The Company ID does not belong to the authenticated merchant
- The Company ID was entered in an incorrect format
Always check the status code before processing the response