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

NameTypeDescription

apiKey*

string

Your Abyiss API Key

Request Body

NameTypeDescription

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

{
    "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
}

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

NameTypeDescription

apiKey*

string

Your Abyiss API Key

[
    {
        "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
    }
]

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

NameTypeDescription

bankAccountId*

string

Bank Account Id

Headers

NameTypeDescription

apiKey*

string

Your Abyiss API Key

{
    "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
}

Copy & Paste Code

POST Bank Accounts

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

GET Bank Accounts

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

Bank Accounts Response Object

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
}

Bank Accounts Response Attributes

Attribute NameData TypeDescription

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.

Last updated