Channel

On this page, we'll dive into the different channel endpoints you can use to manage user channels programmatically. Here, you can create, update, view and delete channels.

The profile model

The Channel model contains all the essential information about the linked account, alias, and channel name.

Properties

Name
access_token
Type
string
Description
Your unique Access Token
Name
user_id
Type
string
Description
Your unique User Id
Name
route_uuid
Type
string
Description
The unique identifier for your channel
Name
alias_uuid
Type
string
Description
The unique identifier for your alias (if you don't want to use your @supatag)
Name
route_name
Type
string
Description
The name of your channel
Name
linked_account_uuid
Type
string
Description
The unique identifier for your external linked account

POST/alias/routing/view

View all channels

This endpoint allows you to view all your aliases

Required Attributes

Name
access_token
Type
string
Description
Your unique Access Token
Name
user_id
Type
string
Description
Your unique User Id

Request

POST

/alias/routing/view

curl -X POST https://api.supesa.io/alias/routing/view \
  -H "content-type: application/json" \
  -d '{
      "access_token": "YOUR_ACCESS_TOKEN",
      "user_id": "YOUR_USER_ID"
    }'

Response

{
  "code": 200,
  "message": [
    {
      "id": 54,
      "created_at": "2023-10-18T09:38:43.435811+00:00",
      "user_id": "bfcfd1fa-8a74-4727-87ce-fbeee2b536ab",
      "route_name": "customer_1",
      "route_uuid": "dedd12ff-b897-4fc5-b741-c814489c257d",
      "linked_account_uuid": "8c5d7aaa-976b-48df-829d-c027a7a56312",
      "alias_uuid": null
    },
    {
      "id": 55,
      "created_at": "2023-10-18T09:38:51.563875+00:00",
      "user_id": "bfcfd1fa-8a74-4727-87ce-fbeee2b536ab",
      "route_name": "customer_2",
      "route_uuid": "97235269-0be4-44d2-891a-f94aed2286ab",
      "linked_account_uuid": "8c5d7aaa-976b-48df-829d-c027a7a56312",
      "alias_uuid": null
    },
    {
      "id": 56,
      "created_at": "2023-10-18T09:38:58.541886+00:00",
      "user_id": "bfcfd1fa-8a74-4727-87ce-fbeee2b536ab",
      "route_name": "customer_3",
      "route_uuid": "da29d9f9-f3b1-45ae-b0eb-47b5245af316",
      "linked_account_uuid": "8c5d7aaa-976b-48df-829d-c027a7a56312",
      "alias_uuid": null
    }
  ],
  "ref": "7def8f91-2bd8-4886-a226-49975fd708f8"
}

POST/alias/routing/new

Create a new channel

This endpoint allows you to create a new channel.

Required Attributes

Name
access_token
Type
string
Description
Your unique Access Token
Name
user_id
Type
string
Description
Your unique User Id
Name
linked_account_uuid
Type
string
Description
The unique identifier for your external linked account
Name
route_name
Type
string
Description
The name of your channel

Optional Attributes

Name
alias_uuid
Type
string
Description
The unique identifier for your alias (if you don't want to use your @supatag)

Request

POST

/alias/routing/new

curl -X POST https://api.supesa.io/alias/routing/new \
  -H "content-type: application/json" \
  -d '{
      "access_token": "YOUR_ACCESS_TOKEN",
      "user_id": "YOUR_USER_ID",
      "linked_account_uuid": "YOUR_LINKED_ACCOUNT_UUID",
      "route_name": "savings"
    }'

Response

{
  "code": 200,
  "message": {
    "user_id": "string",
    "linked_account_uuid": "string",
    "alias_uuid": "string",
    "route_uuid": "string",
    "route_name": "string"
  },
  "ref": "df53f1b2-ade3-4e4e-bf0d-2c72edf45678"
}

POST/alias/routing/update

Update an existing channel

This endpoint allows you to update an existing channel.

Required Attributes

Name
access_token
Type
string
Description
Your unique Access Token
Name
user_id
Type
string
Description
Your unique User Id
Name
route_uuid
Type
string
Description
The unique identifier for your channel

Optional Attributes

Name
alias_uuid
Type
string
Description
The unique identifier for your alias (if you don't want to use your @supatag)
Name
route_name
Type
string
Description
The name of your channel
Name
linked_account_uuid
Type
string
Description
The unique identifier for your external linked account

Request

POST

/alias/routing/update

curl -X POST https://api.supesa.io/alias/routing/update \
  -H "content-type: application/json" \
  -d '{
      "access_token": "YOUR_ACCESS_TOKEN",
      "user_id": "YOUR_USER_ID",
      "route_uuid": "savings"
    }'

Response

{
  "code": 200,
  "message": {
    "user_id": "string",
    "linked_account_uuid": "string",
    "alias_uuid": "string",
    "route_uuid": "string",
    "route_name": "string"
  },
  "ref": "df53f1b2-ade3-4e4e-bf0d-2c72edf45678"
}

POST/alias/routing/delete

Delete an existing channel

This endpoint allows you to delete an existing channel.

Required Attributes

Name
access_token
Type
string
Description
Your unique Access Token
Name
user_id
Type
string
Description
Your unique User Id
Name
route_uuid
Type
string
Description
The unique identifier for your channel

Request

POST

/alias/routing/delete

curl -X POST https://api.supesa.io/alias/routing/delete \
  -H "content-type: application/json" \
  -d '{
      "access_token": "YOUR_ACCESS_TOKEN",
      "user_id": "YOUR_USER_ID",
      "route_uuid": "savings"
    }'

Response

{
  "code": 200,
  "message": {
    "user_id": "string",
    "linked_account_uuid": "string",
    "alias_uuid": "string",
    "route_uuid": "string",
    "route_name": "string"
  },
  "ref": "df53f1b2-ade3-4e4e-bf0d-2c72edf45678"
}