Wallets

The Crypto Wallets API

The Endpoint is in Beta

Introduction

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.
- Deletes a specific wallet by providing the wallet ID.

Wallet API Endpoints

Post Wallets

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

Create a new crypto wallet by providing the required wallet details. Upon a successful request, it returns a 201 status code along with the details of the created wallet.

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.

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

{
    "Unauthorized": "Invaild API Key"
}

Get Wallets

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

Retrieves all crypto wallets associated with the provided API key. Upon a successful request, it returns a 200 status code and a list of wallets.

Headers

Name

Type

Description

apiKey*

string

Your Abyiss API Key

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

{
    "Unauthorized": "Invaild API Key"
}

Get Wallet by ID

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

Retrieves the details of a specific crypto wallet using its unique wallet ID. Upon a successful request, it returns a 200 status code and the details of the requested wallet.

Headers

Name

Type

Description

apiKey*

string

Your Abyiss API Key

Query Parameters

Name

Type

Description

walletId*

string

Wallet Id

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

{
    "Unauthorized": "Invaild API Key"
}

Delete Wallet by ID

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

Deletes a specified crypto wallet using its unique wallet ID. Upon a successful request, it returns a 204 status code indicating that the wallet has been deleted.

Headers

Name

Type

Description

apiKey*

string

Your Abyiss API Key

Query Parameters

Name

Type

Description

walletId*

string

Wallet Id

Response

No Content

{
    "Unauthorized": "Invaild API Key"
}

Copy & Paste Code

POST Wallets

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

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())

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 "https://api.abyiss.com/v2/octane/paymentMethods/wallets?apiKey=YOUR_API_KEY_HERE"

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

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

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,
    "isVerified": false,
    "createdAt": "2024-02-02T02:09:55.963",
    "updatedAt": "2024-02-02T02:09:55.958"
}

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

[
    {
        "id": "wal-123456788",
        "userId": "usr-123456788",
        "address": "someAddress",
        "blockchain": "ethereum",
        "isActive": true,
        "isVerified": false,
        "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,
        "isVerified": false,
        "createdAt": "2024-02-02T02:09:55.963",
        "updatedAt": "2024-02-02T02:09:55.958"
    }
]

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,
    "isVerified": false,
    "createdAt": "2024-02-02T02:09:55.963",
    "updatedAt": "2024-02-02T02:09:55.958"
}

Wallets Response Attributes

Attribute Name

Data Type

Description

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.

isVerified

boolean

Indicates whether the wallet has been verified to exist.

createdAt

string

The timestamp the wallet was updated at.

updatedAt

string

The last timestamp the wallet was updated at.

PreviousBank Accounts NextSubaccounts

Last updated 5 months ago