Wallets

The Octane Wallets API enables you to manage and retrieve information about wallets associated with your account.

The Endpoint is in Alpha

The Octane Wallets API provides developers with functionality to manage and retrieve information related to crypto wallets with their accounts.

• Wallets:

  • Obtain a detailed list of wallets linked to a specific API key.

  • Fetch specific wallet details by querying with the wallet ID.

  • Facilitate the creation of new wallets by submitting wallet information in the request body.

Wallet API Endpoints

Post Wallets

POST https://api.abyiss.com/v2/octane/paymentMethods/wallets

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

Headers

Name	Type	Description
apiKey*	string	Your Abyiss API Key

Request Body

Name	Type	Description
address*	string	The wallet address,
blockchain*	string	The blockchain the wallet is associated with.

201: Created Success

{
    "id": "wal-123456785",
    "userId": "usr-123456788",
    "address": "some-addy",
    "blockchain": "some-chain",
    "isActive": true,
    "createdAt": "2024-02-02T02:09:55.963",
    "updatedAt": "2024-02-02T02:09:55.958"
}

401: Unauthorized Unauthorized -- Invalid API Key

{
    "Unauthorized": "Invaild API Key"
}

Get Wallets

GET https://api.abyiss.com/v2/octane/paymentMethods/wallets

Returns a 200 status code upon successful query. Returns all the of the wallets for an associated apiKey.

Headers

Name	Type	Description
apiKey*	string	Your Abyiss API Key

200: OK Success

[
    {
        "id": "wal-123456788",
        "userId": "usr-123456788",
        "address": "someAddress",
        "blockchain": "ethereum",
        "isActive": true,
        "createdAt": "2024-01-30T15:06:08.568",
        "updatedAt": "2024-01-30T15:06:08.563"
    },
    {
        "id": "wal-123456785",
        "userId": "usr-123456788",
        "address": "some-addy",
        "blockchain": "some-chain",
        "isActive": true,
        "createdAt": "2024-02-02T02:09:55.963",
        "updatedAt": "2024-02-02T02:09:55.958"
    }
]

401: Unauthorized Unauthorized -- Invalid API Key

{
    "Unauthorized": "Invaild API Key"
}

Get Wallet by ID

GET https://api.abyiss.com/v2/octane/paymentMethods/wallets/{walletId}

Returns a 200 status code upon successful query. Returns an object with the given walletIdfor an associated apiKey.

Query Parameters

Name	Type	Description
walletId*	string	Wallet Id

Headers

Name	Type	Description
apiKey*	string	Your Abyiss API Key

200: OK Success

{
    "id": "wal-123456785",
    "userId": "usr-123456788",
    "address": "some-addy",
    "blockchain": "some-chain",
    "isActive": true,
    "createdAt": "2024-02-02T02:09:55.963",
    "updatedAt": "2024-02-02T02:09:55.958"
}

401: Unauthorized Unauthorized -- Invalid API Key

{
    "Unauthorized": "Invaild API Key"
}

Copy & Paste Code

POST Wallets

Curl

curl -X POST \
  -H "Content-Type: application/json" \
  -H "apiKey: 123abc" \
  -d '{
    "wallet": {
      "address": "0xsome-address",
      "blockchain": "Ethereum",
    }
  }' \
  https://api.abyiss.com/v2/octane/paymentMethods/wallets

Python

import requests
import json

url = "https://api.abyiss.com/v2/octane/paymentMethods/wallets"
headers = {
    "Content-Type": "application/json",
    "apiKey": "123abc"
}

wallet_data = {
    "wallet": {
        "address": "0xsome-address",
        "blockchain": "Ethereum"
    }
}

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

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

JavaScript

const axios = require('axios');

const url = 'https://api.abyiss.com/v2/octane/paymentMethods/wallets';
const headers = {
    'Content-Type': 'application/json',
    'apiKey': '123abc'
};

const walletData = {
    wallet: {
        address: '0xsome-address',
        blockchain: 'Ethereum'
    }
};

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

GET Wallets

Curl

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

Python

import requests

url = 'https://api.abyiss.com/v2/octane/paymentMethods/wallets?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/paymentMethods/wallets?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);
  });

Wallets Response Object

POST Wallets

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

{
    "id": "wal-123456785",
    "userId": "usr-123456788",
    "address": "some-addy",
    "blockchain": "some-chain",
    "isActive": true,
    "createdAt": "2024-02-02T02:09:55.963",
    "updatedAt": "2024-02-02T02:09:55.958"
}

Get Wallets

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

[
    {
        "id": "wal-123456788",
        "userId": "usr-123456788",
        "address": "someAddress",
        "blockchain": "ethereum",
        "isActive": true,
        "createdAt": "2024-01-30T15:06:08.568",
        "updatedAt": "2024-01-30T15:06:08.563"
    },
    {
        "id": "wal-123456785",
        "userId": "usr-123456788",
        "address": "some-addy",
        "blockchain": "some-chain",
        "isActive": true,
        "createdAt": "2024-02-02T02:09:55.963",
        "updatedAt": "2024-02-02T02:09:55.958"
    }
]

Get Wallet by Id

Example URL: https://api.abyiss.com/v2/octane/paymentMethods/wallets/wal-123456785?apiKey=

{
    "id": "wal-123456785",
    "userId": "usr-123456788",
    "address": "some-addy",
    "blockchain": "some-chain",
    "isActive": true,
    "createdAt": "2024-02-02T02:09:55.963",
    "updatedAt": "2024-02-02T02:09:55.958"
}

Wallets Response Attributes

Attribute Name	Data Type	Description
id	string	Wallet Id for the user.
userId	string	Unique user Id.
address	string	The crypto wallet address.
blockchain	string	The blockchain the wallet is on.
isActive	boolean	If the wallet is currently active. True or False.
createdAt	string	The timestamp the wallet was updated at.
updatedAt	string	The last timestamp the wallet was updated at.