Okra API endpoints for Accounts

Get account details

post /accounts/getAccountDetails

API endpoint to Get account details

A successful request will return a HTTP 200 status code

HTTP bearer bearer

account

string

required

Account ID of a user

Response

Examples Schema

OK

{
  "status": "success",
  "message": "Account details successfully retrieved",
  "data": {
    "_id": "",
    "name": "BABA LAGBAJA OJONE",
    "nuban": "3558799023",
    "bank": {
      "_id": "5d6fe57a4099cc4b210bbeb2",
      "name": "First City Monument Bank",
      "slug": "first-city-monument-bank",
      "colors": {
        "primary": "#5C2682",
        "accent": "#5C2682",
        "bg": "#8737BC",
        "button": "#5C2682",
        "icon": "#5C2682"
      },
      "icon": "https://okra-images.s3.eu-west-3.amazonaws.com/First+City+Monument+Bank+Ltd+Logo+Color.svg",
      "inverted_logo": "",
      "v2_icon": "",
      "v2_logo": "",
      "status": true,
      "isMFA": false,
      "mfaType": "none",
      "corp": false
    },
    "type": "SALARY CURRNT A/C PREMIUM",
    "customer": "5f2e7ea783997820e41d00a6",
    "env": "production",
    "created_at": "2020-08-08T10:30:17.993Z",
    "last_updated": "2021-06-28T19:15:59.570Z",
    "__v": 0,
    "balance": "5f2e7eba9e5c6e823a13a989",
    "projects": [
      "5ff633889e64635f2629e015",
      "5ff62b99aea7a57a5c3baa01",
      "5ff633889e64635f2629df62",
      "5ff633889e64635f2629df84",
      "5ff633889e64635f2629e05c",
      "5ff633889e64635f2629e0a9",
      "5ff633889e64635f2629e04d",
      "5ff633889e64635f2629e1ef"
    ],
    "manual": true,
    "currency": "NGN"
  }
}

status

string

message

string

data

object (data)

Example
{ "_id": "", "name": "BABA LAGBAJA OJONE", "nuban": "3558799023", "bank": { "_id": "5d6fe57a4099cc4b210bbeb2", "name": "First City Monument Bank", "slug": "first-city-monument-bank", "colors": { "primary": "#5C2682", "accent": "#5C2682", "bg": "#8737BC", "button": "#5C2682", "icon": "#5C2682" }, "icon": "https://okra-images.s3.eu-west-3.amazonaws.com/First+City+Monument+Bank+Ltd+Logo+Color.svg", "inverted_logo": "", "v2_icon": "", "v2_logo": "", "status": true, "isMFA": false, "mfaType": "none", "corp": false }, "type": "SALARY CURRNT A/C PREMIUM", "customer": "5f2e7ea783997820e41d00a6", "env": "production", "created_at": "2020-08-08T10:30:17.993Z", "last_updated": "2021-06-28T19:15:59.570Z", "__v": 0, "balance": "5f2e7eba9e5c6e823a13a989", "projects": [ "5ff633889e64635f2629e015", "5ff62b99aea7a57a5c3baa01", "5ff633889e64635f2629df62", "5ff633889e64635f2629df84", "5ff633889e64635f2629e05c", "5ff633889e64635f2629e0a9", "5ff633889e64635f2629e04d", "5ff633889e64635f2629e1ef" ], "manual": true, "currency": "NGN" }

_id

string

name

string

nuban

string

bank

object (bank)

Example
{ "_id": "5d6fe57a4099cc4b210bbeb2", "name": "First City Monument Bank", "slug": "first-city-monument-bank", "colors": { "primary": "#5C2682", "accent": "#5C2682", "bg": "#8737BC", "button": "#5C2682", "icon": "#5C2682" }, "icon": "https://okra-images.s3.eu-west-3.amazonaws.com/First+City+Monument+Bank+Ltd+Logo+Color.svg", "inverted_logo": "", "v2_icon": "", "v2_logo": "", "status": true, "isMFA": false, "mfaType": "none", "corp": false }

_id

string

name

string

slug

string

colors

object (colors)

Example
{ "primary": "", "accent": "", "bg": "", "button": "", "icon": "" }

primary

string

accent

string

bg

string

button

string

icon

string

icon

string

inverted_logo

string

v2_icon

string

v2_logo

string

status

boolean

isMFA

boolean

mfaType

string

corp

boolean

type

string

customer

string

env

string

created_at

string

last_updated

string

__v

int

i32

balance

string

projects

array[string]

string

manual

boolean

currency

string

Get account by customer

post /accounts/getByCustomer

API endpoint to Get account by customer

A successful request will return a HTTP 200 status code

HTTP bearer bearer

customer

string

required

The customer ID of the user.

Request

{
  "customer": "string"
}

Response

Examples Schema

OK

{
  "status": "success",
  "message": "Accounts retrieved successfully",
  "data": {
    "pagination": {
      "totalDocs": 1,
      "limit": 20,
      "hasPrevPage": false,
      "hasNextPage": false,
      "page": 1,
      "totalPages": 1,
      "pagingCounter": 1,
      "prevPage": null,
      "nextPage": null
    },
    "accounts": [
      {
        "_id": "1279f22572fe4f001e22042b",
        "manual": false,
        "owner": [
          "1da6358130a943486f33dced"
        ],
        "record": [
          "1279f21772fe4f001e22041b",
          "127ca226daa335001fcf8825",
          "12848c7ffb5ac3001e85cc76"
        ],
        "connected": [
          "1da6358130a943486f33dced"
        ],
        "projects": [
          "1ff62b99aea7a57a5c3baa01",
          "1312a300c9a5025268f61186",
          "106ddd326da15957e3c7bdd5"
        ],
        "name": "ICONIC LIVE SHOWBIZ PRODUCTIONS LT",
        "type": "CURRENT",
        "currency": "NGN",
        "env": "production-sandbox",
        "nuban": "1023659424",
        "bank": {
          "name": "Stanbic IBTC Bank",
          "slug": "stanbic-ibtc-bank",
          "logo": "https://okra-images.s3.eu-west-3.amazonaws.com/Stanbic+IBTC+Bank+Logo.svg",
          "icon": "https://okra-images.s3.eu-west-3.amazonaws.com/Stanbic+IBTC+Bank+Logo+Color.svg",
          "status": "healthy"
        },
        "customer": {
          "_id": "14a51342effdb2003a573482",
          "name": "ICONIC LIVE SHOWBIZ PRODUCTIO"
        },
        "created_at": "2022-05-10T05:03:33.726Z",
        "last_updated": "2023-09-25T07:50:56.902Z",
        "__v": 0,
        "balance": "127ca2381f0ef8173c7f95f5",
        "id": "1279f22572fe4f001e22042b"
      }
    ]
  }
}

status

string

The status of your request.

message

string

A short description of the response.

data

object (data)

pagination

object (pagination)

totalDocs

int

i32

The total number of results that match the request.

limit

int

i32

Returns the value of the limit parameter. Limit sets the number of results that the API returns in a single page. If you do not specify a value for limit, the API will limit the response to 10 results per page.

hasPrevPage

boolean

Shows when a previous page of results is available. This field always returns true when the value of page is greater than 1.

hasNextPage

boolean

Shows when a next page of results is available. When true, Okra recommends that you make subsequent requests to retrieve the following pages of results.

page

int

i32

Returns the number of the current page. For example, if you set page to 1 in your request, the API will return the first page of results in the response.

totalPages

int

i32

The total number of pages that the API returns.

pagingCounter

int

i32

The index number of the first result on the current page. For example, if the value of page is 2 and limit is set to 10, then pagingCounter returns 11.

prevPage

string or null

The number of previous result pages. If the value of page is 1 and there is no previous page, the value of prevPage is null.

nextPage

string or null

The number of following result pages. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is null.

account

array[object (Account21)]

The account object.

Account21

object (Account21)

Example
{ "owner": [ "" ], "record": [ "" ], "connected": [ "" ], "_id": "", "name": "", "nuban": "", "bank": { "name": "", "logo": "https://okra-images.s3.eu-west-3.amazonaws.com/Access+Bank+PLC+Logo.svg", "icon": "https://okra-images.s3.eu-west-3.amazonaws.com/Access+Bank+PLC+Logo+Color.svg", "status": "healthy" }, "customer": { "_id": "", "name": "" }, "env": "", "created_at": "", "last_updated": "", "__v": 0, "balance": "" }

owner

array[string]

Returns the ID of the acco

string

record

array[string]

Returns an array of record IDs that are related to this account.

string

connected

array[string]

string

_id

string

A unique identifier that references the account.

name

string

The name of the account holder as returned from the bank.

nuban

string

The NUBAN of the account holder.

customer

object (customer)

_id

string

The unique identifier that references the user.

name

string

The user’s full name.

env

string

The environment variable. Possible values: production, production-sandbox.

created_at

string

The ISO-8601 timestamp of when the data point was first created in Okra's database.

last_updated

string

The ISO-8601 timestamp of when the data point was last updated in Okra's database.

__v

int

i32

balance

string

Returns the ID of the balance record that belongs to the account.

bank

object (bank)

icon

string

A URL that points to the bank's icon.

logo

string

A URL that points to the bank's logo.

name

string

The bank's name.

slug

string

The bank's name in slug format.

status

string

The current connection status of the bank.

Enum
  • down
  • degraded
  • healthy
  • dead

v2_icon

string

A URL that points to the bank's icon.

v2_logo

string

A URL that points to the bank's logo.

Was this page helpful?