Subaccounts

The Octane Subaccounts API allows you to manage and retrieve information about subaccounts associated with your master account.

The Endpoint is in Alpha

Subaccounts are a way to create and manage user accounts under a master account. They can be interacted with using the master account's API key.

• Subaccount:

  • A subaccount is specified via the userId field in the request body or request query, serving as another part of the apiKey.

  • The master account can interact with subaccount payment methods and transactions.

  • The master account cannot interact with subaccounts of a subaccount.

  • Each subaccount can only have one master account.

Subaccounts API Endpoints

Post Subaccount

POST https://api.abyiss.com/v2/octane/subaccounts

Returns a 201 status code upon successful query. Then returns the successful account created.

Headers

Name	Type	Description
apiKey*	string	Blockchain ID

Request Body

Name	Type	Description
name*	string	User name including first and last name.
email*	string	The users email address.

201: Created Success

{
    "newSubAccountId": "usr-123456790"
}

401: Unauthorized Unauthorized -- Invalid API Key

{
    "Unauthorized": "Invaild API Key"
}

Get Subaccounts

GET https://api.abyiss.com/v2/octane/subaccounts

Returns an array of all the accounts for an associated apiKey.

Headers

Name	Type	Description
apiKey*	string	Your Abyiss API Key

200: OK Success

[{
  "id": "usr-123456790",
  "email": "[email protected]",
  "name": "subAccountName",
  "createdAt": "2023-12-10T00:46:14.786",
  "updatedAt": "2023-12-10T00:46:14.783"
},{
  "id": "usr-123457800",
  "email": "[email protected]",
  "name": "Zeek Zubert",
  "createdAt": "2023-12-10T02:18:32.022",
  "updatedAt": "2023-12-10T02:18:32.018"
}]

401: Unauthorized Unauthorized -- Invalid API Key

{
    "Unauthorized": "Invaild API Key"
}

Get Subaccount by ID

GET https://api.abyiss.com/v2/octane/subaccounts/{accountId}

Returns an object for the accountIdfor an associated apiKey.

Query Parameters

Name	Type	Description
accountId*	string	Order ID

Headers

Name	Type	Description
apiKey*	string	Your Abyiss API Key

200: OK Success

{
  "id": "usr-123456790",
  "email": "[email protected]",
  "name": "subAccountName",
  "createdAt": "2023-12-10T00:46:14.786",
  "updatedAt": "2023-12-10T00:46:14.783"
}

401: Unauthorized Unauthorized -- Invalid API Key

{
    "Unauthorized": "Invaild API Key"
}

Copy & Paste Code

POST Subaccounts

Curl

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "api-key": "dev-api-key",
    "subAccount": {
      "name": "Zeek Zubert",
      "email": "[email protected]"
    }
  }' \
  https://api.abyiss.com/v2/octane/subaccounts

Python

import requests
import json

url = "https://api.abyiss.com/v2/octane/subaccounts"
headers = {
    "Content-Type": "application/json"
}

subaccount_data = {
    "api-key": "dev-api-key",
    "subAccount": {
        "name": "Zeek Zubert",
        "email": "[email protected]"
    }
}

response = requests.post(url, headers=headers, data=json.dumps(subaccount_data))

print(response.status_code)
print(response.json())

JavaScript

const axios = require('axios');

const url = 'https://api.abyiss.com/v2/octane/subaccounts';
const headers = {
    'Content-Type': 'application/json'
};

const subaccountData = {
    'api-key': 'dev-api-key',
    'subAccount': {
        'name': 'Zeek Zubert',
        'email': '[email protected]'
    }
};

axios.post(url, subaccountData, { headers })
    .then(response => {
        console.log(response.status);
        console.log(response.data);
    })
    .catch(error => {
        console.error(error.response.status);
        console.error(error.response.data);
    });

GET Subaccounts

Curl

curl "https://api.abyiss.com/v2/octane/subaccounts?apiKey=YOUR_API_KEY_HERE"

Python

import requests

url = 'https://api.abyiss.com/v2/octane/subaccounts?apiKey=YOUR_API_KEY_HERE'

response = requests.get(url)

print(response.status_code)  # This will print the status code of the response
print(response.json())  # This will print the response content as JSON

JavaScript

const url = 'https://api.abyiss.com/v2/octane/subaccounts?apiKey=YOUR_API_KEY_HERE';

fetch(url)
  .then(response => {
    if (!response.ok) {
      throw new Error('Network response was not ok');
    }
    return response.json();
  })
  .then(data => {
    console.log(data); // Handle the response data
  })
  .catch(error => {
    console.error('There has been a problem with your fetch operation:', error);
  });

Subaccounts Response Object

POST Subaccounts

Example URL: https://api.abyiss.com/v2/octane/subaccounts?apiKey=

{
    "newSubAccountId": "usr-123456790"
}

Get Subaccounts

Example URL: https://api.abyiss.com/v2/octane/subaccounts?apiKey=

[{
  "id": "usr-123456790",
  "email": "[email protected]",
  "name": "subAccountName",
  "createdAt": "2023-12-10T00:46:14.786",
  "updatedAt": "2023-12-10T00:46:14.783"
},{
  "id": "usr-123457800",
  "email": "[email protected]",
  "name": "Zeek Zubert",
  "createdAt": "2023-12-10T02:18:32.022",
  "updatedAt": "2023-12-10T02:18:32.018"
}]

Get Subaccount by Id

Example URL: https://api.abyiss.com/v2/octane/subaccounts/usr-123457800?apiKey=

{
  "id": "usr-123457800",
  "email": "[email protected]",
  "name": "Zeek Zubert",
  "createdAt": "2023-12-10T02:18:32.022",
  "updatedAt": "2023-12-10T02:18:32.018"
}

Subaccounts Response Attributes

Attribute Name	Data Type	Description
id	string	Unique user id.
email	string	User email address.
name	string	User first and last name.
createdAt	string	The timestamp the user account was created.
updatedAt	string	The last timestamp the user account was updated at.