Okra

Okra was an African open-finance / open-banking infrastructure company based in Lagos, Nigeria. Its REST API connected applications to Nigerian bank accounts to retrieve authentication details, balances, transactions, identity, and income data, and to initiate bank-to-bank payments, with a Link widget and webhooks. Okra wound down operations in May 2025; this catalog documents the API as it was publicly published.

6 APIs 0 Features

Open BankingOpen FinanceFintechAfricaNigeriaFinancial Data

APIs

Okra Auth & Link API

Connects a customer's bank account via the Okra Link widget and retrieves authentication records - account and NUBAN numbers across current, savings, and domiciliary accounts - ...

Okra Accounts & Balance API

Retrieves a record's linked accounts and real-time ledger and available balances, filterable by id, customer, account, balance type, and date range.

Okra Transactions API

Returns customer-authorized transaction history of up to 24 months across current, savings, and domiciliary accounts, filterable by customer, account, bank, and date, plus a spe...

Okra Identity & Income API

Retrieves KYC identity on file with the bank (names, emails, phone numbers, addresses) and verifies a customer's income data drawn from their connected accounts.

Okra Payments API

Collects one-time and recurring bank-to-bank payments via USSD and internet banking, creates instant and future payments, retrieves and verifies payment status, and supports bul...

Okra Webhooks API

Delivers asynchronous callbacks to a configured callback_url when Okra finishes processing a product's data for a Record, and lets you re-trigger callbacks for a set of record ids.

Collections

Okra API

OPEN

Pricing Plans

Okra Ng Plans Pricing

3 plans

PLANS

Rate Limits

Okra Ng Rate Limits

3 limits

RATE LIMITS

FinOps

Okra Ng Finops

FINOPS

Resources

👥

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: Okra API
  version: '2.0'
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Auth
    type: folder
  items:
  - info:
      name: Retrieve all auth records
      type: http
    http:
      method: POST
      url: https://api.okra.ng/v2/products/auths
      body:
        type: json
        data: "{\n  \"pdf\": false\n}"
    docs: Returns authentication records for all of your customers.
  - info:
      name: Retrieve an auth record by id
      type: http
    http:
      method: POST
      url: https://api.okra.ng/v2/auth/getById
      body:
        type: json
        data: "{\n  \"id\": \"<string>\"\n}"
    docs: Retrieve an auth record by id.
  - info:
      name: Retrieve auth records by customer
      type: http
    http:
      method: POST
      url: https://api.okra.ng/v2/auth/getByCustomer
      body:
        type: json
        data: "{\n  \"customer\": \"<string>\"\n}"
    docs: Retrieve auth records by customer.
  - info:
      name: Retrieve auth records by date range
      type: http
    http:
      method: POST
      url: https://api.okra.ng/v2/auth/getByDate
      body:
        type: json
        data: "{\n  \"from\": \"2024-01-01\",\n  \"to\": \"2024-12-31\"\n}"
    docs: Retrieve auth records by date range.
  - info:
      name: Retrieve auth records by bank
      type: http
    http:
      method: POST
      url: https://api.okra.ng/v2/auth/getByBank
      body:
        type: json
        data: "{\n  \"bank\": \"<string>\"\n}"
    docs: Retrieve auth records by bank.
- info:
    name: Balance
    type: folder
  items:
  - info:
      name: Retrieve all balance records
      type: http
    http:
      method: POST
      url: https://api.okra.ng/v2/products/balances
      body:
        type: json
        data: "{\n  \"pdf\": false\n}"
    docs: Retrieve all balance records.
  - info:
      name: Retrieve a balance record by id
      type: http
    http:
      method: POST
      url: https://api.okra.ng/v2/balance/getById
      body:
        type: json
        data: "{\n  \"id\": \"<string>\"\n}"
    docs: Retrieve a balance record by id.
  - info:
      name: Retrieve balances by customer
      type: http
    http:
      method: POST
      url: https://api.okra.ng/v2/balance/getByCustomer
      body:
        type: json
        data: "{\n  \"customer\": \"<string>\"\n}"
    docs: Retrieve balances by customer.
  - info:
      name: Retrieve balances by account
      type: http
    http:
      method: POST
      url: https://api.okra.ng/v2/balance/getByAccount
      body:
        type: json
        data: "{\n  \"account\": \"<string>\"\n}"
    docs: Retrieve balances by account.
  - info:
      name: Retrieve balances by type and value
      type: http
    http:
      method: POST
      url: https://api.okra.ng/v2/balance/getByType
      body:
        type: json
        data: "{\n  \"type\": \"available\",\n  \"value\": 1000\n}"
    docs: Retrieve balances by type and value.
- info:
    name: Accounts
    type: folder
  items:
  - info:
      name: Retrieve all linked accounts
      type: http
    http:
      method: POST
      url: https://api.okra.ng/v2/products/accounts
      body:
        type: json
        data: "{\n  \"pdf\": false\n}"
    docs: Retrieve all linked accounts.
- info:
    name: Transactions
    type: folder
  items:
  - info:
      name: Retrieve all transaction records
      type: http
    http:
      method: POST
      url: https://api.okra.ng/v2/products/transactions
      body:
        type: json
        data: "{\n  \"pdf\": false\n}"
    docs: Retrieve all transaction records.
  - info:
      name: Retrieve transactions by customer
      type: http
    http:
      method: POST
      url: https://api.okra.ng/v2/transaction/getByCustomer
      body:
        type: json
        data: "{\n  \"customer\": \"<string>\"\n}"
    docs: Retrieve transactions by customer.
  - info:
      name: Retrieve transactions by account
      type: http
    http:
      method: POST
      url: https://api.okra.ng/v2/transaction/getByAccount
      body:
        type: json
        data: "{\n  \"account\": \"<string>\"\n}"
    docs: Retrieve transactions by account.
  - info:
      name: Retrieve transactions by date range
      type: http
    http:
      method: POST
      url: https://api.okra.ng/v2/transaction/getByDate
      body:
        type: json
        data: "{\n  \"from\": \"2024-01-01\",\n  \"to\": \"2024-12-31\"\n}"
    docs: Retrieve transactions by date range.
  - info:
      name: Retrieve transactions by bank
      type: http
    http:
      method: POST
      url: https://api.okra.ng/v2/transaction/getByBank
      body:
        type: json
        data: "{\n  \"bank\": \"<string>\"\n}"
    docs: Retrieve transactions by bank.
  - info:
      name: Retrieve a customer's spending pattern
      type: http
    http:
      method: POST
      url: https://api.okra.ng/v2/products/transactions/spending-pattern
      body:
        type: json
        data: "{\n  \"customer_id\": \"<string>\"\n}"
    docs: Retrieve a customer's spending pattern.
- info:
    name: Identity
    type: folder
  items:
  - info:
      name: Retrieve all identity records
      type: http
    http:
      method: POST
      url: https://api.okra.ng/v2/products/identities
      body:
        type: json
        data: "{\n  \"pdf\": false\n}"
    docs: Retrieve all identity records.
  - info:
      name: Retrieve an identity record by id
      type: http
    http:
      method: POST
      url: https://api.okra.ng/v2/identity/getById
      body:
        type: json
        data: "{\n  \"id\": \"<string>\"\n}"
    docs: Retrieve an identity record by id.
  - info:
      name: Retrieve identity by customer
      type: http
    http:
      method: POST
      url: https://api.okra.ng/v2/identity/getByCustomer
      body:
        type: json
        data: "{\n  \"customer\": \"<string>\"\n}"
    docs: Retrieve identity by customer.
  - info:
      name: Retrieve identity records by date range
      type: http
    http:
      method: POST
      url: https://api.okra.ng/v2/identity/getByDate
      body:
        type: json
        data: "{\n  \"from\": \"2024-01-01\",\n  \"to\": \"2024-12-31\"\n}"
    docs: Retrieve identity records by date range.
- info:
    name: Income
    type: folder
  items:
  - info:
      name: Retrieve income records
      type: http
    http:
      method: POST
      url: https://api.okra.ng/v2/products/income
      body:
        type: json
        data: "{\n  \"pdf\": false\n}"
    docs: Retrieve income verification records.
  - info:
      name: Retrieve income by customer
      type: http
    http:
      method: POST
      url: https://api.okra.ng/v2/income/getByCustomer
      body:
        type: json
        data: "{\n  \"customer\": \"<string>\"\n}"
    docs: Retrieve income by customer.
- info:
    name: Payments
    type: folder
  items:
  - info:
      name: Initiate a bank-to-bank payment
      type: http
    http:
      method: POST
      url: https://api.okra.ng/v2/products/pay
      body:
        type: json
        data: "{\n  \"amount\": 1000,\n  \"currency\": \"NGN\",\n  \"account\": \"<string>\"\n}"
    docs: Initiate an instant bank-to-bank payment.
  - info:
      name: Verify a payment
      type: http
    http:
      method: POST
      url: https://api.okra.ng/v2/pay/verify
      body:
        type: json
        data: "{\n  \"payment_id\": \"<string>\"\n}"
    docs: Verify a payment.
  - info:
      name: Retrieve a payment by id
      type: http
    http:
      method: POST
      url: https://api.okra.ng/v2/pay/getById
      body:
        type: json
        data: "{\n  \"id\": \"<string>\"\n}"
    docs: Retrieve a payment by id.
- info:
    name: Webhooks
    type: folder
  items:
  - info:
      name: Re-trigger webhook callbacks
      type: http
    http:
      method: POST
      url: https://api.okra.ng/v2/callback/trigger
      body:
        type: json
        data: "{\n  \"recordIds\": [\"<string>\"],\n  \"url\": \"https://example.com/webhook\"\n}"
    docs: Re-trigger webhook callbacks for the supplied record ids.