Company API

Documentation on how to use the company API via OAuth2 in SePay.

Introduction

SePay’s company API allows you to access information about the current company and its configurations. This API is only for users with the Admin or SuperAdmin role in the company.
To use this API, your Access Token must include the company scope and you must be a user with the Admin or SuperAdmin role.

Endpoints

The company API provides the following endpoints:
GET
/api/v1/company
- Get information about the current company
PATCH
/api/v1/company/configurations
- Update company configurations

Get company information

GET

/api/v1/company

Authorization: Bearer {YOUR_ACCESS_TOKEN}

This endpoint returns information about the current company and related configurations.
Required permissions
- Scope: company
- User role: Admin or SuperAdmin

RESPONSE

{
  "status": "success",
  "data": {
    "id": 123,
    "full_name": "ABC One Member Limited Company",
    "short_name": "ABC Corp",
    "role": "Admin",
    "status": "active",
    "subscription": "Premium",
    "begin_date": "2023-01-01",
    "end_date": "2023-12-31",
    "configurations": {
      "bank_sub_account": true,
      "paycode": true,
      "data_storage_time": "90",
      "payment_code_formats": [
        {
          "prefix": "DH",
          "suffix_from": 6,
          "suffix_to": 8,
          "character_type": "NumberOnly",
          "is_active": true
        },
        {
          "prefix": "HD",
          "suffix_from": 4,
          "suffix_to": 6,
          "character_type": "NumberAndLetter",
          "is_active": true
        }
      ]
    }
  }
}

idinteger

Company ID

full_namestring

Company’s full name

short_namestring

Company’s short name

rolestring

User’s role within the company

statusstring

Company status (active, inactive, etc.)

subscriptionstring

Company’s subscription plan

begin_datestring

Subscription start date

end_datestring

Subscription end date

configurationsobject

Company configuration settings

Update company configurations

PATCH

/api/v1/company/configurations

Authorization: Bearer {YOUR_ACCESS_TOKEN}

This endpoint allows updating the company’s configurations, especially the payment code structure.
Required permissions
- Scope: company
- User role: Admin or SuperAdmin

Name	Type	Required	Description
`payment_code_formats`	array	Required	List of payment code formats (required if submitted)

bash

Successful response

RESPONSE

{
  "status": "success",
  "data": {
    "status": true,
    "data": {
      "bank_sub_account": true,
      "paycode": true,
      "data_storage_time": "90",
      "payment_code_formats": [
        {
          "prefix": "DH",
          "suffix_from": 6,
          "suffix_to": 8,
          "character_type": "NumberOnly",
          "is_active": true
        },
        {
          "prefix": "HD",
          "suffix_from": 4,
          "suffix_to": 6,
          "character_type": "NumberAndLetter",
          "is_active": true
        }
      ]
    }
  }
}

Error response

RESPONSE

{
  "status": "success",
  "data": {
    "status": false,
    "message": "Payment code suffix 'from' must be less than or equal to suffix 'to' (Payment code structure 1)"
  }
}

Error codes

Below are possible error codes when using the company API:

HTTP Code	Description	Cause
401	Unauthorized Access token is invalid or expired	—
403	Forbidden Insufficient privileges (not an Admin or SuperAdmin)	—
400	Bad Request Invalid payload (does not satisfy constraints)	—
500	Internal Server Error Server error while processing the request	—