Create label

POST

https://api.staging.vrtx.sa/cl/v1/labels

Last modified:2025-12-03 07:59:44

Create a new label that can be assigned to wallets, business accounts, or transactions within the closed-loop ecosystem.
Labels help classify and organize financial entities..

This endpoint is typically used by administrators or internal systems to define new categories for tagging and reporting.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "business_id": "01df2b9e-e17b-4372-a589-a627fc2c6929",
    "name": "VAT"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.staging.vrtx.sa/cl/v1/labels' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "business_id": "01df2b9e-e17b-4372-a589-a627fc2c6929",
    "name": "VAT"
}'

Responses

🟢201Created

application/json

Created

Body

Example

{
    "id": "f6ff1999-d2b3-41fa-a7a9-dfd6b88b4e51",
    "business_id": "2bb58ca6-1b9a-47b4-ab4d-b2996f0498f3",
    "name": "Fees Wallet - رسوم",
    "created_at": "2025-10-25T14:44:06.296Z"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Modified at 2025-12-03 07:59:44

List labels

List transactions