{ "info": { "_postman_id": "0e239e4a-b7c8-4385-910b-a9de5740b901", "name": "Okra API", "description": { "content": "Okra open-finance API (v2). All endpoints are POST and authenticated with a Bearer secret key. NOTE: Okra wound down operations in May 2025; endpoints may no longer be live.", "type": "text/plain" }, "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "id": "36ca0dd0-504f-4638-b84b-9642ce6ecb54", "name": "Auth", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "e08928c6-a51a-4f16-84d3-299fa57b778e", "name": "Retrieve all auth records", "request": { "name": "Retrieve all auth records", "description": {}, "url": { "path": [ "products", "auths" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"pdf\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "b82eb7fb-a44d-4233-9694-6a57e406e2ba", "name": "Retrieve an auth record by id", "request": { "name": "Retrieve an auth record by id", "description": {}, "url": { "path": [ "auth", "getById" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "59a67f34-49fd-498a-85e1-4e8f940285b1", "name": "Retrieve auth records by customer", "request": { "name": "Retrieve auth records by customer", "description": {}, "url": { "path": [ "auth", "getByCustomer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"customer\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "620ee6f8-9f82-42bb-94de-8e7338b2cc9d", "name": "Retrieve auth records by date range", "request": { "name": "Retrieve auth records by date range", "description": {}, "url": { "path": [ "auth", "getByDate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"from\": \"2024-01-01\",\n \"to\": \"2024-12-31\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "f1d7a8f3-e3bd-4772-9941-71a1a8c8e666", "name": "Retrieve auth records by bank", "request": { "name": "Retrieve auth records by bank", "description": {}, "url": { "path": [ "auth", "getByBank" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"bank\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "id": "c5de15e5-4e2a-4bb5-bb3f-cc60dea33fd8", "name": "Balance", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "ff929b4b-abf8-4515-8075-a2f5cb43beb8", "name": "Retrieve all balance records", "request": { "name": "Retrieve all balance records", "description": {}, "url": { "path": [ "products", "balances" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"pdf\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "984a14ab-a5b8-44a4-b618-1c83dbd3f37f", "name": "Retrieve a balance record by id", "request": { "name": "Retrieve a balance record by id", "description": {}, "url": { "path": [ "balance", "getById" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "3bf4c3e6-7908-420a-904d-a140fb27001a", "name": "Retrieve balances by customer", "request": { "name": "Retrieve balances by customer", "description": {}, "url": { "path": [ "balance", "getByCustomer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"customer\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "9c702501-6d9b-4d6d-bd40-0c9e34fb1a2e", "name": "Retrieve balances by account", "request": { "name": "Retrieve balances by account", "description": {}, "url": { "path": [ "balance", "getByAccount" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"account\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "6d2cd02c-600c-4bfd-b797-e181b99bf27b", "name": "Retrieve balances by type and value", "request": { "name": "Retrieve balances by type and value", "description": {}, "url": { "path": [ "balance", "getByType" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"type\": \"available\",\n \"value\": 1000\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "id": "4a7addb1-ec28-4a5b-b0a9-c4c5b4028f4a", "name": "Accounts", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "f80780a3-ecea-4c08-ae4b-2972f3cf93eb", "name": "Retrieve all linked accounts", "request": { "name": "Retrieve all linked accounts", "description": {}, "url": { "path": [ "products", "accounts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"pdf\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "id": "888f3c85-a22e-4a8f-a420-0aed2d7b277a", "name": "Transactions", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "7f52a4f8-364b-4ff1-b7e8-b0633e6b4fbe", "name": "Retrieve all transaction records", "request": { "name": "Retrieve all transaction records", "description": {}, "url": { "path": [ "products", "transactions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"pdf\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "e0076cb1-7df9-496d-8061-1b81ebd5fe2f", "name": "Retrieve transactions by customer", "request": { "name": "Retrieve transactions by customer", "description": {}, "url": { "path": [ "transaction", "getByCustomer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"customer\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "f5c64bd2-0d51-430b-9165-77e27989ee8c", "name": "Retrieve transactions by account", "request": { "name": "Retrieve transactions by account", "description": {}, "url": { "path": [ "transaction", "getByAccount" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"account\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "59aae0d6-9fac-48df-9e50-281b9364c540", "name": "Retrieve transactions by date range", "request": { "name": "Retrieve transactions by date range", "description": {}, "url": { "path": [ "transaction", "getByDate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"from\": \"2024-01-01\",\n \"to\": \"2024-12-31\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "4460d796-2b67-4777-9d62-c0dcd273a151", "name": "Retrieve transactions by bank", "request": { "name": "Retrieve transactions by bank", "description": {}, "url": { "path": [ "transaction", "getByBank" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"bank\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "30a8d2f4-e477-4c3e-bd9a-b3844ad094f8", "name": "Retrieve a customer's spending pattern", "request": { "name": "Retrieve a customer's spending pattern", "description": {}, "url": { "path": [ "products", "transactions", "spending-pattern" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"customer_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "id": "f69ef70b-c624-42d7-81dd-582bd3994e4d", "name": "Identity", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "66a8526e-3725-4d24-9f94-c088ecadc03d", "name": "Retrieve all identity records", "request": { "name": "Retrieve all identity records", "description": {}, "url": { "path": [ "products", "identities" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"pdf\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "96ef297c-5580-46f7-853c-a013253461a2", "name": "Retrieve an identity record by id", "request": { "name": "Retrieve an identity record by id", "description": {}, "url": { "path": [ "identity", "getById" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "4c498c7d-c76c-4e7e-9310-65d33bc9eebc", "name": "Retrieve identity by customer", "request": { "name": "Retrieve identity by customer", "description": {}, "url": { "path": [ "identity", "getByCustomer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"customer\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "118abda5-0b77-4915-8a08-98ded6fb3198", "name": "Retrieve identity records by date range", "request": { "name": "Retrieve identity records by date range", "description": {}, "url": { "path": [ "identity", "getByDate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"from\": \"2024-01-01\",\n \"to\": \"2024-12-31\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "id": "2635e790-2fc4-4007-8104-dc9e91cd0b20", "name": "Income", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "803fd719-22e4-4b95-9d47-67b2573bb165", "name": "Retrieve income records", "request": { "name": "Retrieve income records", "description": {}, "url": { "path": [ "products", "income" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"pdf\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "13a1843a-6e73-4889-bac6-39bf3b813737", "name": "Retrieve income by customer", "request": { "name": "Retrieve income by customer", "description": {}, "url": { "path": [ "income", "getByCustomer" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"customer\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "id": "6748f704-0ad1-4967-8424-5b1a6ffb896f", "name": "Payments", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "39ed95ac-e409-4683-8e87-d89b40d9aa15", "name": "Initiate a bank-to-bank payment", "request": { "name": "Initiate a bank-to-bank payment", "description": {}, "url": { "path": [ "products", "pay" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"amount\": 1000,\n \"currency\": \"NGN\",\n \"account\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "3ce9397c-86c4-4656-a180-cfac60ed4c30", "name": "Verify a payment", "request": { "name": "Verify a payment", "description": {}, "url": { "path": [ "pay", "verify" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"payment_id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "id": "fa9cabf4-abd0-4331-9cf6-b284b37fb200", "name": "Retrieve a payment by id", "request": { "name": "Retrieve a payment by id", "description": {}, "url": { "path": [ "pay", "getById" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"id\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "id": "530473e1-8ee1-4669-ac09-b8c833f52be1", "name": "Webhooks", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "4fc74133-9821-4b3e-9bff-ac57b1ae151b", "name": "Re-trigger webhook callbacks", "request": { "name": "Re-trigger webhook callbacks", "description": {}, "url": { "path": [ "callback", "trigger" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"recordIds\": [\n \"\"\n ],\n \"url\": \"https://example.com/webhook\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.okra.ng/v2" }, { "key": "bearerToken", "value": "" } ] }