Bank Accounts

The Octane Bank Accounts API enables you to manage and retrieve information about bank accounts associated with your account.

The Endpoint is in Alpha

The Octane Bank Accounts API provides developers with functionality to manage and retrieve information related to bank accounts with their accounts.

• Bank Accounts:

  • Retrieve a comprehensive list of bank accounts associated with a given API key.

  • Access specific bank account details by querying with the bank account ID.

  • Create new bank accounts by providing essential details in the request body.

Bank Account API Endpoints

Post Bank Accounts

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

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

Headers

Name	Type	Description
apiKey*	string	Your Abyiss API Key

Request Body

Name	Type	Description
routingNumber*	string	The bank account routing number.
accountNumber*	string	The bank account number.
bankName*	string	The bank name.
wireNumber*	string	The bank account wire number.
ibanNumber	string	International Bank Account Number (IBAN)
type*	string	Bank Account Type ("BUSINESS_CHECKING", "BUSINESS_SAVINGS", "SAVINGS", "CHECKING")
country	string	Country of International Bank Account. Country where the bank is located.
fiatCurrency	string	Bank Account Fiat Currency Type. Default USD.
swiftCode	string	International Bank Account Swift Code
nationalId	string	International Bank Account National Id

201: Created Success

{
    "id": "bac-123456791",
    "routingNumber": "12345",
    "accountNumber": "67890",
    "bankName": "Bank of America",
    "createdAt": "2024-02-02T02:03:28.738",
    "updatedAt": "2024-02-02T02:03:28.734",
    "userId": "usr-123456788",
    "isActive": true,
    "wireNumber": null,
    "ibanNumber": null,
    "type": "BUSINESS_CHECKING",
    "country": "UNITED_STATES",
    "fiatCurrency": "USD",
    "swiftCode": null,
    "nationalId": null
}

401: Unauthorized Unauthorized -- Invalid API Key

{
    "Unauthorized": "Invaild API Key"
}

Get Bank Accounts

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

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

Query Parameters

Name	Type	Description
apiKey*	string	Your Abyiss API Key

200: OK Success

[
    {
        "id": "bac-123456791",
        "routingNumber": "12345",
        "accountNumber": "67890",
        "bankName": "Bank of America",
        "createdAt": "2024-02-02T02:03:28.738",
        "updatedAt": "2024-02-02T02:03:28.734",
        "userId": "usr-123456788",
        "isActive": true,
        "wireNumber": "987654",
        "ibanNumber": null,
        "type": "BUSINESS_CHECKING",
        "country": "UNITED_STATES",
        "fiatCurrency": "USD",
        "swiftCode": null,
        "nationalId": null
    }
]

401: Unauthorized Unauthorized -- Invalid API Key

{
    "Unauthorized": "Invaild API Key"
}

Get Bank Account by ID

GET https://api.abyiss.com/v2/octane/paymentMethods/bankAccounts/{bankAccountId}

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

Query Parameters

Name	Type	Description
bankAccountId*	string	Bank Account Id

Headers

Name	Type	Description
apiKey*	string	Your Abyiss API Key

200: OK Success

{
    "id": "bac-123456791",
    "routingNumber": "12345",
    "accountNumber": "67890",
    "bankName": "Bank of America",
    "createdAt": "2024-02-02T02:03:28.738",
    "updatedAt": "2024-02-02T02:03:28.734",
    "userId": "usr-123456788",
    "isActive": true,
    "wireNumber": null,
    "ibanNumber": null,
    "type": "BUSINESS_CHECKING",
    "country": "UNITED_STATES",
    "fiatCurrency": "USD",
    "swiftCode": null,
    "nationalId": null
}

401: Unauthorized Unauthorized -- Invalid API Key

{
    "Unauthorized": "Invaild API Key"
}

Copy & Paste Code

POST Bank Accounts

Curl

curl -X POST \
  -H "Content-Type: application/json" \
  -H "apiKey: your-api-key" \
  -d '{
    "bankAccount": {
      "routingNumber": "12345",
      "accountNumber": "67890",
      "bankName": "Bank of America",
      "wireNumber": "12345",
      "type": "BUSINESS_CHECKING"
    }
  }' \
  https://api.abyiss.com/v2/octane/paymentMethods/bankAccounts

Python

import requests
import json

url = "https://api.abyiss.com/v2/octane/paymentMethods/bankAccounts"
headers = {
    "Content-Type": "application/json",
    "apiKey": "your-api-key"
}

bank_account_data = {
    "bankAccount": {
        "routingNumber": "12345",
        "accountNumber": "67890",
        "bankName": "Bank of America",
        "wireNumber": "12345",
        "type": "BUSINESS_CHECKING"
    }
}

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

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

JavaScript

const axios = require('axios');

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

const bankAccountData = {
    bankAccount: {
        routingNumber: '12345',
        accountNumber: '67890',
        bankName: 'Bank of America',
        wireNumber: '12345',
        type: 'BUSINESS_CHECKING'
    }
};

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

GET Bank Accounts

Curl

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

Python

import requests

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

Bank Accounts Response Object

POST Bank Accounts

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

{
  "id": "bac-123456788",
  "routingNumber": "12555345",
  "accountNumber": "67555890",
  "bankName": "Bank of America",
  "createdAt": "2024-01-30T15:51:52.405",
  "updatedAt": "2024-01-30T15:51:52.398",
  "userId": "usr-123456788",
  "isActive": true,
  "wireNumber": "44335534",
  "ibanNumber": null,
  "type": "BUSINESS_CHECKING",
  "country": "UNITED_STATES",
  "fiatCurrency": "USD",
  "swiftCode": null,
  "nationalId": null
}

Get Bank Accounts

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

[{
  "id": "bac-123456788",
  "routingNumber": "12555345",
  "accountNumber": "67555890",
  "bankName": "Bank of America",
  "createdAt": "2024-01-30T15:51:52.405",
  "updatedAt": "2024-01-30T15:51:52.398",
  "userId": "usr-123456788",
  "isActive": true,
  "wireNumber": "44335534",
  "ibanNumber": null,
  "type": "BUSINESS_CHECKING",
  "country": "UNITED_STATES",
  "fiatCurrency": "USD",
  "swiftCode": null,
  "nationalId": null
}, {
  "id": "bac-123456788",
  "routingNumber": "12555345",
  "accountNumber": "67555890",
  "bankName": "Bank of America",
  "createdAt": "2024-01-30T15:51:52.405",
  "updatedAt": "2024-01-30T15:51:52.398",
  "userId": "usr-123456788",
  "isActive": true,
  "wireNumber": "44335534",
  "ibanNumber": null,
  "type": "BUSINESS_CHECKING",
  "country": "UNITED_STATES",
  "fiatCurrency": "USD",
  "swiftCode": null,
  "nationalId": null
}]

Get Bank Account by Id

Example URL: https://api.abyiss.com/v2/octane/paymentMethods/bankAccounts/bac-123456788?apiKey=

{
  "id": "bac-123456788",
  "routingNumber": "12555345",
  "accountNumber": "67555890",
  "bankName": "Bank of America",
  "createdAt": "2024-01-30T15:51:52.405",
  "updatedAt": "2024-01-30T15:51:52.398",
  "userId": "usr-123456788",
  "isActive": true,
  "wireNumber": "44335534",
  "ibanNumber": null,
  "type": "BUSINESS_CHECKING",
  "country": "UNITED_STATES",
  "fiatCurrency": "USD",
  "swiftCode": null,
  "nationalId": null
}

Bank Accounts Response Attributes

Attribute Name	Data Type	Description
id	string	Unique bank account id.
routingNumber	string	The routing number for the bank account.
accountNumber	string	The account number for the bank account.
bankName	string	The name of the bank associated with the bank account.
createdAt	string	The timestamp the bank account was created at.
updatedAt	string	The last timestamp the bank account was updated at.
userId	string	Unique user id.
isActive	boolean	If the bank account is currently active. True or False.
wireNumber	string	The wire number for the bank account.
ibanNumber	string	International Bank Account Number.
type	string	Bank Account Type ("BUSINESS_CHECKING", "BUSINESS_SAVINGS", "SAVINGS", "CHECKING")
country	string	Bank Account Country Location ("UNITED_STATES")
fiatCurrency	string	Bank Account Fiat Currency. Default USD
swiftCode	string	International Bank Account Swift Code
nationalId	string	Interntaional Bank Account National Id number.