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
apiKey*
string
Blockchain ID
Request Body
name*
string
User name including first and last name.
email*
string
The users email address.
{
"newSubAccountId": "usr-123456790"
}
Get Subaccounts
GET
https://api.abyiss.com/v2/octane/subaccounts
Returns an array of all the accounts for an associated apiKey
.
Headers
apiKey*
string
Your Abyiss API Key
[{
"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
GET
https://api.abyiss.com/v2/octane/subaccounts/{accountId}
Returns an object for the accountId
for an associated apiKey
.
Query Parameters
accountId*
string
Order ID
Headers
apiKey*
string
Your Abyiss API Key
{
"id": "usr-123456790",
"email": "[email protected]",
"name": "subAccountName",
"createdAt": "2023-12-10T00:46:14.786",
"updatedAt": "2023-12-10T00:46:14.783"
}
Copy & Paste Code
POST Subaccounts
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
GET Subaccounts
curl "https://api.abyiss.com/v2/octane/subaccounts?apiKey=YOUR_API_KEY_HERE"
Subaccounts Response Object
Example URL: https://api.abyiss.com/v2/octane/subaccounts?apiKey=
{
"newSubAccountId": "usr-123456790"
}
Subaccounts Response Attributes
id
string
Unique user id.
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.
Last updated
Was this helpful?