Rehive logo
Powered by Redocly

subtypes

List subtypes

SecurityapiAuth
Request
query Parameters
archived
boolean
created
string <date-time>
created__gt
string <date-time>
created__gte
string <date-time>
created__lt
string <date-time>
created__lte
string <date-time>
name
string
partner__isnull
boolean
tx_type
string
usage_type
string
Responses
200
get/3/admin/subtypes/
Request samples 
rehive.admin.subtypes.get()
.then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "success",
  • "data": [
    ]
}

Create subtype

SecurityapiAuth
Request
Request Body schema:
required
name
required
string <= 50 characters
label
string or null <= 50 characters
description
string or null <= 255 characters
tx_type
required
string
  • credit - Credit
  • debit - Debit
Enum: "credit" "debit"
usage_type
string or null
Deprecated
  • partner - Partner
  • single - Single
Enum: "partner" "single" null
partner
integer or null
archived
boolean
Default: false
Responses
201
post/3/admin/subtypes/
Request samples
{
  • "name": "string",
  • "label": "string",
  • "description": "string",
  • "tx_type": "credit",
  • "usage_type": "partner",
  • "partner": 0,
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Retrieve subtype

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
Responses
200
get/3/admin/subtypes/{id}/
Request samples 
rehive.admin.subtypes.get({"id": serviceId})
.then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Update subtype

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
Request Body schema:
required
name
required
string <= 50 characters
label
string or null <= 50 characters
description
string or null <= 255 characters
usage_type
string or null
Deprecated
  • partner - Partner
  • single - Single
Enum: "partner" "single" null
partner
integer or null
archived
boolean
Default: false
Responses
200
put/3/admin/subtypes/{id}/
Request samples
{
  • "name": "string",
  • "label": "string",
  • "description": "string",
  • "usage_type": "partner",
  • "partner": 0,
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Partially update subtype

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
Request Body schema:
name
string <= 50 characters
label
string or null <= 50 characters
description
string or null <= 255 characters
usage_type
string or null
Deprecated
  • partner - Partner
  • single - Single
Enum: "partner" "single" null
partner
integer or null
archived
boolean
Default: false
Responses
200
patch/3/admin/subtypes/{id}/
Request samples
{
  • "name": "string",
  • "label": "string",
  • "description": "string",
  • "usage_type": "partner",
  • "partner": 0,
  • "archived": false
}
Response samples
application/json
{
  • "status": "success",
  • "data": {
    }
}

Delete subtype

SecurityapiAuth
Request
path Parameters
id
required
string^\d+$
Responses
200
delete/3/admin/subtypes/{id}/
Request samples 
rehive.admin.subtypes.delete(serviceId)
.then(function (res) {
    ...
}, function (err) {
    ...
});
Response samples
application/json
{
  • "status": "sucess"
}
➔ Next to transaction-collections