{ "openapi": "3.0.0", "info": { "title": "Blnk", "contact": {}, "version": "1.0" }, "servers": [ { "url": "http://localhost:5001", "variables": {} } ], "paths": { "/ledgers": { "post": { "summary": "Create ledger", "operationId": "Createledger", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateledgerRequest" }, { "example": { "name": "Customer wallets Ledger", "meta_data": { "project_owner": "Blnk Tech" } } } ] }, "example": { "name": "Customer wallets Ledger", "meta_data": { "project_owner": "Blnk Tech" } } } }, "required": true }, "responses": { "201": { "description": "Created", "headers": { "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Tue, 20 Feb 2024 05:28:03 GMT" } } }, "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "128" } } } }, "content": { "application/json; charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Createledger" }, { "example": { "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "name": "Customer wallets Ledger", "created_at": "2024-02-20T05:28:03.558281542Z", "meta_data": { "project_owner": "Blnk Tech" } } } ] }, "example": { "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "name": "Customer wallets Ledger", "created_at": "2024-02-20T05:28:03.558281542Z", "meta_data": { "project_owner": "Blnk Tech" } } } } } }, "deprecated": false, "security": [ { "basic": [] } ] } }, "/balances": { "post": { "summary": "Create Balance", "operationId": "CreateBalance", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateBalanceRequest" }, { "example": { "ledger_id": "ldg_63d9915b-926f-49d6-93b2-4acc5ab214ed", "currency": "NGN" } } ] }, "example": { "ledger_id": "ldg_63d9915b-926f-49d6-93b2-4acc5ab214ed", "currency": "NGN" } } }, "required": true }, "responses": { "201": { "description": "Created", "headers": { "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Tue, 20 Feb 2024 05:33:01 GMT" } } }, "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "282" } } } }, "content": { "application/json; charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateBalance" }, { "example": { "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "balance": 0, "version": 0, "inflight_balance": 0, "credit_balance": 0, "inflight_credit_balance": 0, "debit_balance": 0, "inflight_debit_balance": 0, "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "identity_id": "", "indicator": "", "currency": "NGN", "created_at": "2024-02-20T05:33:01.311600208Z", "inflight_expires_at": "0001-01-01T00:00:00Z", "meta_data": null } } ] }, "example": { "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "balance": 0, "version": 0, "inflight_balance": 0, "credit_balance": 0, "inflight_credit_balance": 0, "debit_balance": 0, "inflight_debit_balance": 0, "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "identity_id": "", "indicator": "", "currency": "NGN", "created_at": "2024-02-20T05:33:01.311600208Z", "inflight_expires_at": "0001-01-01T00:00:00Z", "meta_data": null } } } } }, "deprecated": false } }, "/transactions": { "post": { "summary": "Record Transaction", "operationId": "RecordTransaction", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RecordTransactionRequest" }, { "example": { "precise_amount": 74000, "precision": 100, "reference": "reference", "sources": [ { "identifier": "bln_f2073f6b-905a-4e3e-b5a2-8d1b3dc2fb7f", "distribution": "10%", "narration": "Monthly contribution" }, { "identifier": "bln_64c50fb5-32d5-4f78-9f4a-e8b01aaf025d", "precise_distribution": "2000000", "narration": "Monthly contribution" }, { "identifier": "bln_7d98dfe9-5c3e-4c9b-b96a-65f6d9f7b89b", "distribution": "left", "narration": "Monthly contribution" } ], "destinations": [ { "identifier": "bln_f2073f6b-905a-4e3e-b5a2-8d1b3dc2fb7f", "distribution": "20%", "narration": "For groceries" }, { "identifier": "bln_64c50fb5-32d5-4f78-9f4a-e8b01aaf025d", "precise_distribution": "1000000", "narration": "For electricity bills" }, { "identifier": "bln_7d98dfe9-5c3e-4c9b-b96a-65f6d9f7b89b", "distribution": "left", "narration": "For savings" } ], "currency": "NGN", "source": "@inflighttest6", "destination": "@inflighttest7", "allow_over_draft": true, "inflight": true } } ] }, "example": { "precise_amount": 74000, "precision": 100, "reference": "reference", "sources": [ { "identifier": "bln_f2073f6b-905a-4e3e-b5a2-8d1b3dc2fb7f", "distribution": "10%", "narration": "Monthly contribution" }, { "identifier": "bln_64c50fb5-32d5-4f78-9f4a-e8b01aaf025d", "precise_distribution": "2000000", "narration": "Monthly contribution" }, { "identifier": "bln_7d98dfe9-5c3e-4c9b-b96a-65f6d9f7b89b", "distribution": "left", "narration": "Monthly contribution" } ], "destinations": [ { "identifier": "bln_f2073f6b-905a-4e3e-b5a2-8d1b3dc2fb7f", "distribution": "20%", "narration": "For groceries" }, { "identifier": "bln_64c50fb5-32d5-4f78-9f4a-e8b01aaf025d", "precise_distribution": "1000000", "narration": "For electricity bills" }, { "identifier": "bln_7d98dfe9-5c3e-4c9b-b96a-65f6d9f7b89b", "distribution": "left", "narration": "For savings" } ], "currency": "NGN", "source": "@inflighttest6", "destination": "@inflighttest7", "allow_over_draft": true, "inflight": true } } }, "required": true }, "responses": { "201": { "description": "Created", "headers": { "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Sun, 07 Apr 2024 08:17:25 GMT" } } }, "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "403" } } } }, "content": { "application/json; charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RecordTransaction" }, { "example": { "amount": 74000, "id": "txn_d0440bb5-e2c2-4937-bb4c-e91b50b7df22", "allow_overdraft": true, "infligt": true, "source": "@inflighttest6", "destination": "@inflighttest7", "reference": "reference", "currency": "NGN", "description": "", "status": "INFLIGHT", "hash": "89ba8954cd8e9215feed757be7cebe0a3ec9440be22139a5ba6a0499a52f4593", "group_ids": null, "created_at": "0001-01-01T00:00:00Z", "scheduled_for": "0001-01-01T00:00:00Z", "inflight_expiry_date": "0001-01-01T00:00:00Z", "inflight_commit_date": "0001-01-01T00:00:00Z" } } ] }, "example": { "amount": 74000, "id": "txn_d0440bb5-e2c2-4937-bb4c-e91b50b7df22", "allow_overdraft": true, "infligt": true, "source": "@inflighttest6", "destination": "@inflighttest7", "reference": "reference", "currency": "NGN", "description": "", "status": "INFLIGHT", "hash": "89ba8954cd8e9215feed757be7cebe0a3ec9440be22139a5ba6a0499a52f4593", "group_ids": null, "created_at": "0001-01-01T00:00:00Z", "scheduled_for": "0001-01-01T00:00:00Z", "inflight_expiry_date": "0001-01-01T00:00:00Z", "inflight_commit_date": "0001-01-01T00:00:00Z" } } } } }, "deprecated": false } }, "/transactions/inflight/{txID}": { "put": { "summary": "Update Inflight Transaction", "operationId": "UpdateInflightTransaction", "parameters": [ { "name": "txID", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "txn_d0440bb5-e2c2-4937-bb4c-e91b50b7df22" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateInflightTransactionRequest" }, { "example": { "status": "void" } } ] }, "example": { "status": "void" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Sun, 07 Apr 2024 08:20:06 GMT" } } }, "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "402" } } } }, "content": { "application/json; charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateInflightTransaction" }, { "example": { "amount": 74000, "precision": 0, "transaction_id": "txn_bd9ab37f-e353-450d-8210-1958bd50254a", "parent_transaction": "txn_5cc1e86b-47be-4aba-a400-48e7b9edfedd", "allow_overdraft": false, "infligt": false, "source": "bln_8ab15e8f-da33-428f-b3f8-ab3d1c1dda09", "destination": "bln_76ceff93-fcac-47e0-84ee-88e086359064", "reference": "reference", "currency": "NGN", "description": "", "status": "VOID", "hash": "032af5e26c8a2c2690f1bb70bdd7c044bbdf9c7f5576fc0f693200baf65a9ee3", "created_at": "2024-04-07T08:20:06.494307542Z", "scheduled_for": "0001-01-01T00:00:00Z", "inflight_expiry_date": "0001-01-01T00:00:00Z", "inflight_commit_date": "0001-01-01T00:00:00Z" } } ] }, "example": { "amount": 74000, "precision": 0, "transaction_id": "txn_bd9ab37f-e353-450d-8210-1958bd50254a", "parent_transaction": "txn_5cc1e86b-47be-4aba-a400-48e7b9edfedd", "allow_overdraft": false, "infligt": false, "source": "bln_8ab15e8f-da33-428f-b3f8-ab3d1c1dda09", "destination": "bln_76ceff93-fcac-47e0-84ee-88e086359064", "reference": "reference", "currency": "NGN", "description": "", "status": "VOID", "hash": "032af5e26c8a2c2690f1bb70bdd7c044bbdf9c7f5576fc0f693200baf65a9ee3", "created_at": "2024-04-07T08:20:06.494307542Z", "scheduled_for": "0001-01-01T00:00:00Z", "inflight_expiry_date": "0001-01-01T00:00:00Z", "inflight_commit_date": "0001-01-01T00:00:00Z" } } } } }, "deprecated": false } }, "/refund-transaction/{id}": { "post": { "summary": "Refund Transaction", "operationId": "RefundTransaction", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "txn_5bbbe4d3-2d82-4da1-8191-aaa491d025de" } } ], "responses": { "201": { "description": "Created", "headers": { "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Tue, 20 Feb 2024 05:40:52 GMT" } } }, "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "713" } } } }, "content": { "application/json; charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/RefundTransaction" }, { "example": { "id": "txn_043d4ac3-4caf-4149-9c0d-927ae637d83f", "tag": "Refund", "reference": "ref_70ffd90f-7bcf-43b8-90ba-70505c113b52", "amount": 300, "currency": "NGN", "payment_method": "", "description": "", "drcr": "Debit", "status": "APPLIED", "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "credit_balance_before": 600, "debit_balance_before": 0, "credit_balance_after": 600, "debit_balance_after": 300, "balance_before": 600, "balance_after": 300, "created_at": "2024-02-20T05:40:52.630481718Z", "scheduled_for": "0001-01-01T00:00:00Z", "risk_tolerance_threshold": 0, "risk_score": 0.03108, "meta_data": { "refunded_transaction_id": "txn_5bbbe4d3-2d82-4da1-8191-aaa491d025de" }, "group_ids": null } } ] }, "example": { "id": "txn_043d4ac3-4caf-4149-9c0d-927ae637d83f", "tag": "Refund", "reference": "ref_70ffd90f-7bcf-43b8-90ba-70505c113b52", "amount": 300, "currency": "NGN", "payment_method": "", "description": "", "drcr": "Debit", "status": "APPLIED", "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "credit_balance_before": 600, "debit_balance_before": 0, "credit_balance_after": 600, "debit_balance_after": 300, "balance_before": 600, "balance_after": 300, "created_at": "2024-02-20T05:40:52.630481718Z", "scheduled_for": "0001-01-01T00:00:00Z", "risk_tolerance_threshold": 0, "risk_score": 0.03108, "meta_data": { "refunded_transaction_id": "txn_5bbbe4d3-2d82-4da1-8191-aaa491d025de" }, "group_ids": null } } } } }, "deprecated": false } }, "/balance-monitors": { "post": { "summary": "Create Balance Monitor", "operationId": "CreateBalanceMonitor", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateBalanceMonitorRequest" }, { "example": { "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "condition": { "field": "debit_balance", "operator": ">", "value": 100000 }, "call_back_url": "https://api.myapp.com/balancemonitor" } } ] }, "example": { "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "condition": { "field": "debit_balance", "operator": ">", "value": 100000 }, "call_back_url": "https://api.myapp.com/balancemonitor" } } }, "required": true }, "responses": { "201": { "description": "Created", "headers": { "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Tue, 20 Feb 2024 05:56:58 GMT" } } }, "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "268" } } } }, "content": { "application/json; charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateBalanceMonitor" }, { "example": { "monitor_id": "mon_e0e77b0c-4985-472a-9bf5-76a48b0259b0", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "condition": { "field": "debit_balance", "operator": ">", "value": 100000 }, "description": "", "call_back_url": "https://api.myapp.com/balancemonitor", "created_at": "2024-02-20T05:56:58.257315054Z" } } ] }, "example": { "monitor_id": "mon_e0e77b0c-4985-472a-9bf5-76a48b0259b0", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "condition": { "field": "debit_balance", "operator": ">", "value": 100000 }, "description": "", "call_back_url": "https://api.myapp.com/balancemonitor", "created_at": "2024-02-20T05:56:58.257315054Z" } } } } }, "deprecated": false } }, "/identities": { "post": { "summary": "Create Identity", "operationId": "CreateIdentity", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateIdentityRequest" }, { "example": { "identity_type": "organization", "name": "Blnk", "category": "fintech", "street": "10 Aso Villa Way", "country": "Nigeria", "state": "Lagos", "post_code": "101001", "city": "Lagos", "created_at": "2023-10-16T10:00:00Z", "meta_data": { "verified": true, "reference": "XYZ123456789" } } } ] }, "example": { "identity_type": "organization", "name": "Blnk", "category": "fintech", "street": "10 Aso Villa Way", "country": "Nigeria", "state": "Lagos", "post_code": "101001", "city": "Lagos", "created_at": "2023-10-16T10:00:00Z", "meta_data": { "verified": true, "reference": "XYZ123456789" } } } }, "required": true }, "responses": { "201": { "description": "Created", "headers": { "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Tue, 20 Feb 2024 05:27:44 GMT" } } }, "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "479" } } } }, "content": { "application/json; charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateIdentity" }, { "example": { "identity_id": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db", "identity_type": "organization", "organization_name": "", "category": "fintech", "first_name": "", "last_name": "", "other_names": "", "gender": "", "dob": "0001-01-01T00:00:00Z", "email_address": "", "phone_number": "", "nationality": "", "street": "10 Aso Villa Way", "country": "Nigeria", "state": "Lagos", "post_code": "101001", "city": "Lagos", "created_at": "2024-02-20T05:27:44.748526423Z", "meta_data": { "reference": "XYZ123456789", "verified": true } } } ] }, "example": { "identity_id": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db", "identity_type": "organization", "organization_name": "", "category": "fintech", "first_name": "", "last_name": "", "other_names": "", "gender": "", "dob": "0001-01-01T00:00:00Z", "email_address": "", "phone_number": "", "nationality": "", "street": "10 Aso Villa Way", "country": "Nigeria", "state": "Lagos", "post_code": "101001", "city": "Lagos", "created_at": "2024-02-20T05:27:44.748526423Z", "meta_data": { "reference": "XYZ123456789", "verified": true } } } } } }, "deprecated": false } }, "/accounts": { "post": { "summary": "Create Account", "operationId": "CreateAccount", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAccountRequest" }, { "example": { "bank_name": "Bknk bank", "number": "30888334", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "identity_id": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db" } } ] }, "example": { "bank_name": "Bknk bank", "number": "30888334", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "identity_id": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db" } } }, "required": true }, "responses": { "201": { "description": "Created", "headers": { "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Tue, 20 Feb 2024 05:35:55 GMT" } } }, "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "423" } } } }, "content": { "application/json; charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAccount" }, { "example": { "account_id": "acc_463b25b8-7b24-4e8b-aa49-7844d9074019", "name": "Chijioke Adeola", "number": "294364850431", "bank_name": "Blnk Bank", "currency": "NGN", "created_at": "2024-02-20T05:35:55.720731136Z", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "identity_id": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db", "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "meta_data": null, "ledger": null, "balance": null, "identity": null } } ] }, "example": { "account_id": "acc_463b25b8-7b24-4e8b-aa49-7844d9074019", "name": "Chijioke Adeola", "number": "294364850431", "bank_name": "Blnk Bank", "currency": "NGN", "created_at": "2024-02-20T05:35:55.720731136Z", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "identity_id": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db", "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "meta_data": null, "ledger": null, "balance": null, "identity": null } } } } }, "deprecated": false } }, "/identities/{id}": { "put": { "summary": "Update Identity", "operationId": "UpdateIdentity", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateIdentityRequest" }, { "example": { "identity_type": "individual", "first_name": "Chijioke", "last_name": "Adeola", "other_names": "Emeka", "gender": "male", "dob": "1990-01-01T00:00:00Z", "email_address": "chijioke.adeola@gmail.com", "phone_number": "+2347012345678", "nationality": "Nigerian", "street": "10 Aso Villa Way", "country": "Nigeria", "state": "Lagos", "post_code": "101001", "city": "Lagos", "created_at": "2023-10-16T10:00:00Z", "meta_data": { "verified": true, "reference": "XYZ123456789" } } } ] }, "example": { "identity_type": "individual", "first_name": "Chijioke", "last_name": "Adeola", "other_names": "Emeka", "gender": "male", "dob": "1990-01-01T00:00:00Z", "email_address": "chijioke.adeola@gmail.com", "phone_number": "+2347012345678", "nationality": "Nigerian", "street": "10 Aso Villa Way", "country": "Nigeria", "state": "Lagos", "post_code": "101001", "city": "Lagos", "created_at": "2023-10-16T10:00:00Z", "meta_data": { "verified": true, "reference": "XYZ123456789" } } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": { "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Tue, 20 Feb 2024 05:28:19 GMT" } } }, "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "43" } } } }, "content": { "application/json; charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateIdentity" }, { "example": { "message": "Identity updated successfully" } } ] }, "example": { "message": "Identity updated successfully" } } } } }, "deprecated": false }, "get": { "summary": "Get Identity", "operationId": "GetIdentity", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db" } } ], "responses": { "200": { "description": "OK", "headers": { "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Tue, 20 Feb 2024 05:28:41 GMT" } } }, "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "530" } } } }, "content": { "application/json; charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetIdentity" }, { "example": { "identity_id": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db", "identity_type": "individual", "organization_name": "", "category": "", "first_name": "Chijioke", "last_name": "Adeola", "other_names": "Emeka", "gender": "male", "dob": "1990-01-01T00:00:00Z", "email_address": "chijioke.adeola@gmail.com", "phone_number": "+2347012345678", "nationality": "Nigerian", "street": "10 Aso Villa Way", "country": "Nigeria", "state": "Lagos", "post_code": "101001", "city": "Lagos", "created_at": "2023-10-16T10:00:00Z", "meta_data": { "reference": "XYZ123456789", "verified": true } } } ] }, "example": { "identity_id": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db", "identity_type": "individual", "organization_name": "", "category": "", "first_name": "Chijioke", "last_name": "Adeola", "other_names": "Emeka", "gender": "male", "dob": "1990-01-01T00:00:00Z", "email_address": "chijioke.adeola@gmail.com", "phone_number": "+2347012345678", "nationality": "Nigerian", "street": "10 Aso Villa Way", "country": "Nigeria", "state": "Lagos", "post_code": "101001", "city": "Lagos", "created_at": "2023-10-16T10:00:00Z", "meta_data": { "reference": "XYZ123456789", "verified": true } } } } } }, "deprecated": false } }, "/accounts/{id}": { "put": { "summary": "Update Account", "operationId": "UpdateAccount", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateAccountRequest" }, { "example": { "bank_name": "Bknk bank MFB", "number": "30888334", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "identity_id": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db" } } ] }, "example": { "bank_name": "Bknk bank MFB", "number": "30888334", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "identity_id": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db" } } }, "required": true }, "responses": { "201": { "description": "Created", "headers": { "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Tue, 20 Feb 2024 05:35:55 GMT" } } }, "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "423" } } } }, "content": { "application/json; charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateAccount" }, { "example": { "account_id": "acc_463b25b8-7b24-4e8b-aa49-7844d9074019", "name": "Chijioke Adeola", "number": "294364850431", "bank_name": "Blnk Bank", "currency": "NGN", "created_at": "2024-02-20T05:35:55.720731136Z", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "identity_id": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db", "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "meta_data": null, "ledger": null, "balance": null, "identity": null } } ] }, "example": { "account_id": "acc_463b25b8-7b24-4e8b-aa49-7844d9074019", "name": "Chijioke Adeola", "number": "294364850431", "bank_name": "Blnk Bank", "currency": "NGN", "created_at": "2024-02-20T05:35:55.720731136Z", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "identity_id": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db", "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "meta_data": null, "ledger": null, "balance": null, "identity": null } } } } }, "deprecated": false }, "get": { "summary": "Get Account", "operationId": "GetAccount", "parameters": [ { "name": "include", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "identity" } }, { "name": "id", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "acc_463b25b8-7b24-4e8b-aa49-7844d9074019" } } ], "responses": { "200": { "description": "OK", "headers": { "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Tue, 20 Feb 2024 05:50:24 GMT" } } }, "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "1343" } } } }, "content": { "application/json; charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetAccount" }, { "example": { "account_id": "acc_463b25b8-7b24-4e8b-aa49-7844d9074019", "name": "Chijioke Adeola", "number": "294364850431", "bank_name": "Blnk Bank", "currency": "NGN", "created_at": "0001-01-01T00:00:00Z", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "identity_id": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db", "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "meta_data": { "reference": "XYZ123456789", "verified": true }, "ledger": { "id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "name": "Customer wallets Ledger", "created_at": "2024-02-20T05:28:03.563132Z" }, "balance": { "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "balance": 30300, "credit_balance": 30600, "debit_balance": 300, "currency": "NGN", "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "identity_id": "", "created_at": "2024-02-20T05:33:01.3116Z", "meta_data": null }, "identity": { "identity_id": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db", "identity_type": "individual", "organization_name": "", "category": "", "first_name": "Chijioke", "last_name": "Adeola", "other_names": "Emeka", "gender": "male", "dob": "1990-01-01T00:00:00Z", "email_address": "chijioke.adeola@gmail.com", "phone_number": "+2347012345678", "nationality": "Nigerian", "street": "10 Aso Villa Way", "country": "Nigeria", "state": "Lagos", "post_code": "101001", "city": "Lagos", "created_at": "2023-10-16T10:00:00Z", "meta_data": null } } } ] }, "example": { "account_id": "acc_463b25b8-7b24-4e8b-aa49-7844d9074019", "name": "Chijioke Adeola", "number": "294364850431", "bank_name": "Blnk Bank", "currency": "NGN", "created_at": "0001-01-01T00:00:00Z", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "identity_id": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db", "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "meta_data": { "reference": "XYZ123456789", "verified": true }, "ledger": { "id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "name": "Customer wallets Ledger", "created_at": "2024-02-20T05:28:03.563132Z" }, "balance": { "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "balance": 30300, "credit_balance": 30600, "debit_balance": 300, "currency": "NGN", "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "identity_id": "", "created_at": "2024-02-20T05:33:01.3116Z", "meta_data": null }, "identity": { "identity_id": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db", "identity_type": "individual", "organization_name": "", "category": "", "first_name": "Chijioke", "last_name": "Adeola", "other_names": "Emeka", "gender": "male", "dob": "1990-01-01T00:00:00Z", "email_address": "chijioke.adeola@gmail.com", "phone_number": "+2347012345678", "nationality": "Nigerian", "street": "10 Aso Villa Way", "country": "Nigeria", "state": "Lagos", "post_code": "101001", "city": "Lagos", "created_at": "2023-10-16T10:00:00Z", "meta_data": null } } } } } }, "deprecated": false } }, "/balance-monitors/{id}": { "put": { "summary": "Update Balance Monitor", "operationId": "UpdateBalanceMonitor", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "mon_da573822-902c-4349-86c9-2c02ab697c6e" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpdateBalanceMonitorRequest" }, { "example": { "balance_id": "bln_c1750613-b4b0-4cde-9793-459165a8715f", "condition": { "field": "balance", "operator": "=", "value": 10000000 } } } ] }, "example": { "balance_id": "bln_c1750613-b4b0-4cde-9793-459165a8715f", "condition": { "field": "balance", "operator": "=", "value": 10000000 } } } }, "required": true }, "responses": { "200": { "description": "", "headers": {} } }, "deprecated": false }, "get": { "summary": "Get Balance Monitor", "operationId": "GetBalanceMonitor", "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "mon_e0e77b0c-4985-472a-9bf5-76a48b0259b0" } } ], "responses": { "200": { "description": "OK", "headers": { "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Tue, 20 Feb 2024 05:59:11 GMT" } } }, "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "265" } } } }, "content": { "application/json; charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetBalanceMonitor" }, { "example": { "monitor_id": "mon_e0e77b0c-4985-472a-9bf5-76a48b0259b0", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "condition": { "field": "debit_balance", "operator": ">", "value": 100000 }, "description": "", "call_back_url": "https://api.myapp.com/balancemonitor", "created_at": "2024-02-20T05:56:58.257315Z" } } ] }, "example": { "monitor_id": "mon_e0e77b0c-4985-472a-9bf5-76a48b0259b0", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "condition": { "field": "debit_balance", "operator": ">", "value": 100000 }, "description": "", "call_back_url": "https://api.myapp.com/balancemonitor", "created_at": "2024-02-20T05:56:58.257315Z" } } } } }, "deprecated": false } }, "/backup": { "post": { "summary": "Back DB", "operationId": "BackDB", "parameters": [], "responses": { "201": { "description": "Created", "headers": { "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Tue, 20 Feb 2024 05:42:41 GMT" } } }, "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "645" } } } }, "content": { "application/json; charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateEvent" }, { "example": { "id": "txn_ea438725-e677-405c-9552-4c549837c622", "tag": "", "reference": "1jhbs3ozmen0k7y5e333feeme3rrr33ewwedffdew", "amount": 30000, "currency": "NGN", "payment_method": "", "description": "", "drcr": "Credit", "status": "QUEUED", "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "credit_balance_before": 600, "debit_balance_before": 300, "credit_balance_after": 30600, "debit_balance_after": 300, "balance_before": 300, "balance_after": 30300, "created_at": "2024-02-20T05:42:41.686457754Z", "scheduled_for": "0001-01-01T00:00:00Z", "risk_tolerance_threshold": 0, "risk_score": 0.12020571428571429, "group_ids": null } } ] }, "example": { "id": "txn_ea438725-e677-405c-9552-4c549837c622", "tag": "", "reference": "1jhbs3ozmen0k7y5e333feeme3rrr33ewwedffdew", "amount": 30000, "currency": "NGN", "payment_method": "", "description": "", "drcr": "Credit", "status": "QUEUED", "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "credit_balance_before": 600, "debit_balance_before": 300, "credit_balance_after": 30600, "debit_balance_after": 300, "balance_before": 300, "balance_after": 30300, "created_at": "2024-02-20T05:42:41.686457754Z", "scheduled_for": "0001-01-01T00:00:00Z", "risk_tolerance_threshold": 0, "risk_score": 0.12020571428571429, "group_ids": null } } } } }, "deprecated": false } }, "/backup/s3": { "post": { "summary": "Back DB To S3", "operationId": "BackDBToS3", "parameters": [], "responses": { "201": { "description": "Created", "headers": { "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Tue, 20 Feb 2024 05:42:41 GMT" } } }, "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "645" } } } }, "content": { "application/json; charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateEvent" }, { "example": { "id": "txn_ea438725-e677-405c-9552-4c549837c622", "tag": "", "reference": "1jhbs3ozmen0k7y5e333feeme3rrr33ewwedffdew", "amount": 30000, "currency": "NGN", "payment_method": "", "description": "", "drcr": "Credit", "status": "QUEUED", "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "credit_balance_before": 600, "debit_balance_before": 300, "credit_balance_after": 30600, "debit_balance_after": 300, "balance_before": 300, "balance_after": 30300, "created_at": "2024-02-20T05:42:41.686457754Z", "scheduled_for": "0001-01-01T00:00:00Z", "risk_tolerance_threshold": 0, "risk_score": 0.12020571428571429, "group_ids": null } } ] }, "example": { "id": "txn_ea438725-e677-405c-9552-4c549837c622", "tag": "", "reference": "1jhbs3ozmen0k7y5e333feeme3rrr33ewwedffdew", "amount": 30000, "currency": "NGN", "payment_method": "", "description": "", "drcr": "Credit", "status": "QUEUED", "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "credit_balance_before": 600, "debit_balance_before": 300, "credit_balance_after": 30600, "debit_balance_after": 300, "balance_before": 300, "balance_after": 30300, "created_at": "2024-02-20T05:42:41.686457754Z", "scheduled_for": "0001-01-01T00:00:00Z", "risk_tolerance_threshold": 0, "risk_score": 0.12020571428571429, "group_ids": null } } } } }, "deprecated": false } }, "/ledgers/{ledger_id}": { "get": { "summary": "Get Ledger", "operationId": "GetLedger", "parameters": [ { "name": "ledger_id", "in": "path", "description": "Unique identification number for your ledger", "required": true, "style": "simple", "schema": { "type": "string", "example": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc" } } ], "responses": { "200": { "description": "OK", "headers": { "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Tue, 20 Feb 2024 05:43:29 GMT" } } }, "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "125" } } } }, "content": { "application/json; charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Ledger" }, { "example": { "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "name": "Customer wallets Ledger", "created_at": "2024-02-20T05:28:03.563132Z", "meta_data": { "project_owner": "Blnk Tech" } } } ] }, "example": { "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "name": "Customer wallets Ledger", "created_at": "2024-02-20T05:28:03.563132Z", "meta_data": { "project_owner": "Blnk Tech" } } } } } }, "deprecated": false } }, "/balances/{id}": { "get": { "summary": "Get Balance", "operationId": "GetBalance", "parameters": [ { "name": "include", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "string", "example": "ledger" } }, { "name": "id", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string", "example": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0" } } ], "responses": { "200": { "description": "OK", "headers": { "Date": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "Tue, 20 Feb 2024 05:38:01 GMT" } } }, "Content-Length": { "content": { "text/plain": { "schema": { "type": "string" }, "example": "416" } } } }, "content": { "application/json; charset=utf-8": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetBalance1" }, { "example": { "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "balance": 300, "credit_balance": 300, "debit_balance": 0, "currency": "NGN", "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "identity_id": "", "ledger": { "id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "name": "Customer wallets Ledger", "created_at": "2024-02-20T05:28:03.563132Z" }, "created_at": "2024-02-20T05:33:01.3116Z", "meta_data": null } } ] }, "example": { "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "balance": 300, "credit_balance": 300, "debit_balance": 0, "currency": "NGN", "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "identity_id": "", "ledger": { "id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "name": "Customer wallets Ledger", "created_at": "2024-02-20T05:28:03.563132Z" }, "created_at": "2024-02-20T05:33:01.3116Z", "meta_data": null } } } } }, "deprecated": false } } }, "components": { "schemas": { "CreateledgerRequest": { "title": "CreateledgerRequest", "required": [ "name", "meta_data" ], "type": "object", "properties": { "name": { "type": "string" }, "meta_data": { "$ref": "#/components/schemas/MetaData" } }, "example": { "name": "Customer wallets Ledger", "meta_data": { "project_owner": "Blnk Tech" } } }, "MetaData": { "title": "MetaData", "required": [ "project_owner" ], "type": "object", "properties": { "project_owner": { "type": "string" } }, "example": { "project_owner": "Blnk Tech" } }, "Createledger": { "title": "Createledger", "required": [ "ledger_id", "name", "created_at", "meta_data" ], "type": "object", "properties": { "ledger_id": { "type": "string" }, "name": { "type": "string" }, "created_at": { "type": "string" }, "meta_data": { "$ref": "#/components/schemas/MetaData" } }, "example": { "id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "name": "Customer wallets Ledger", "created_at": "2024-02-20T05:28:03.558281542Z", "meta_data": { "project_owner": "Blnk Tech" } } }, "CreateBalanceRequest": { "title": "CreateBalanceRequest", "required": [ "ledger_id", "currency" ], "type": "object", "properties": { "ledger_id": { "type": "string" }, "currency": { "type": "string" } }, "example": { "ledger_id": "ldg_63d9915b-926f-49d6-93b2-4acc5ab214ed", "currency": "NGN" } }, "CreateBalance": { "title": "CreateBalance", "required": [ "balance_id", "balance", "version", "inflight_balance", "credit_balance", "inflight_credit_balance", "debit_balance", "inflight_debit_balance", "ledger_id", "identity_id", "indicator", "currency", "created_at", "inflight_expires_at", "meta_data" ], "type": "object", "properties": { "balance_id": { "type": "string" }, "balance": { "type": "integer", "format": "int32" }, "version": { "type": "integer", "format": "int32" }, "inflight_balance": { "type": "integer", "format": "int32" }, "credit_balance": { "type": "integer", "format": "int32" }, "inflight_credit_balance": { "type": "integer", "format": "int32" }, "debit_balance": { "type": "integer", "format": "int32" }, "inflight_debit_balance": { "type": "integer", "format": "int32" }, "ledger_id": { "type": "string" }, "identity_id": { "type": "string" }, "indicator": { "type": "string" }, "currency": { "type": "string" }, "created_at": { "type": "string" }, "inflight_expires_at": { "type": "string" }, "meta_data": { "type": "string", "nullable": true } }, "example": { "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "balance": 0, "version": 0, "inflight_balance": 0, "credit_balance": 0, "inflight_credit_balance": 0, "debit_balance": 0, "inflight_debit_balance": 0, "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "identity_id": "", "indicator": "", "currency": "NGN", "created_at": "2024-02-20T05:33:01.311600208Z", "inflight_expires_at": "0001-01-01T00:00:00Z", "meta_data": null } }, "RecordTransactionRequest": { "title": "RecordTransactionRequest", "required": [ "amount", "reference", "sources", "destinations", "currency", "source", "destination", "allow_over_draft", "inflight" ], "type": "object", "properties": { "amount": { "type": "integer", "format": "int32" }, "reference": { "type": "string" }, "sources": { "type": "array", "items": { "$ref": "#/components/schemas/Source" }, "description": "" }, "destinations": { "type": "array", "items": { "$ref": "#/components/schemas/Destination" }, "description": "" }, "currency": { "type": "string" }, "source": { "type": "string" }, "destination": { "type": "string" }, "allow_over_draft": { "type": "boolean" }, "inflight": { "type": "boolean" }, "inflight_expiry_date": { "type": "string", "description": "RFC3339 datetime with offset (e.g. 2024-04-22T15:28:03+00:00). When inflight is true, the transaction is voided after this time." }, "inflight_commit_date": { "type": "string", "description": "RFC3339 datetime with offset. When inflight is true, Blnk automatically commits at this time. See /transactions/inflight/updating-inflight docs." } }, "example": { "precise_amount": 74000, "precision": 100, "reference": "reference", "sources": [ { "identifier": "bln_f2073f6b-905a-4e3e-b5a2-8d1b3dc2fb7f", "distribution": "10%", "narration": "Monthly contribution" }, { "identifier": "bln_64c50fb5-32d5-4f78-9f4a-e8b01aaf025d", "precise_distribution": "2000000", "narration": "Monthly contribution" }, { "identifier": "bln_7d98dfe9-5c3e-4c9b-b96a-65f6d9f7b89b", "distribution": "left", "narration": "Monthly contribution" } ], "destinations": [ { "identifier": "bln_f2073f6b-905a-4e3e-b5a2-8d1b3dc2fb7f", "distribution": "20%", "narration": "For groceries" }, { "identifier": "bln_64c50fb5-32d5-4f78-9f4a-e8b01aaf025d", "precise_distribution": "1000000", "narration": "For electricity bills" }, { "identifier": "bln_7d98dfe9-5c3e-4c9b-b96a-65f6d9f7b89b", "distribution": "left", "narration": "For savings" } ], "currency": "NGN", "source": "@inflighttest6", "destination": "@inflighttest7", "allow_over_draft": true, "inflight": true } }, "Source": { "title": "Source", "required": [ "identifier", "distribution", "narration" ], "type": "object", "properties": { "identifier": { "type": "string" }, "distribution": { "type": "string" }, "narration": { "type": "string" } }, "example": { "identifier": "bln_f2073f6b-905a-4e3e-b5a2-8d1b3dc2fb7f", "distribution": "10%", "narration": "Monthly contribution" } }, "Destination": { "title": "Destination", "required": [ "identifier", "distribution", "narration" ], "type": "object", "properties": { "identifier": { "type": "string" }, "distribution": { "type": "string" }, "narration": { "type": "string" } }, "example": { "identifier": "bln_f2073f6b-905a-4e3e-b5a2-8d1b3dc2fb7f", "distribution": "20%", "narration": "For groceries" } }, "RecordTransaction": { "title": "RecordTransaction", "required": [ "amount", "id", "allow_overdraft", "infligt", "source", "destination", "reference", "currency", "description", "status", "hash", "group_ids", "created_at", "scheduled_for" ], "type": "object", "properties": { "amount": { "type": "integer", "format": "int32" }, "id": { "type": "string" }, "allow_overdraft": { "type": "boolean" }, "infligt": { "type": "boolean" }, "source": { "type": "string" }, "destination": { "type": "string" }, "reference": { "type": "string" }, "currency": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string" }, "hash": { "type": "string" }, "group_ids": { "type": "string", "nullable": true }, "created_at": { "type": "string" }, "scheduled_for": { "type": "string" }, "inflight_expiry_date": { "type": "string", "description": "RFC3339 datetime with offset when unset shown as zero time." }, "inflight_commit_date": { "type": "string", "description": "RFC3339 datetime with offset when unset shown as zero time; automatic commit when inflight." } }, "example": { "amount": 74000, "id": "txn_d0440bb5-e2c2-4937-bb4c-e91b50b7df22", "allow_overdraft": true, "infligt": true, "source": "@inflighttest6", "destination": "@inflighttest7", "reference": "reference", "currency": "NGN", "description": "", "status": "INFLIGHT", "hash": "89ba8954cd8e9215feed757be7cebe0a3ec9440be22139a5ba6a0499a52f4593", "group_ids": null, "created_at": "0001-01-01T00:00:00Z", "scheduled_for": "0001-01-01T00:00:00Z", "inflight_expiry_date": "0001-01-01T00:00:00Z", "inflight_commit_date": "0001-01-01T00:00:00Z" } }, "UpdateInflightTransactionRequest": { "title": "UpdateInflightTransactionRequest", "required": [ "status" ], "type": "object", "properties": { "status": { "type": "string" } }, "example": { "status": "void" } }, "UpdateInflightTransaction": { "title": "UpdateInflightTransaction", "required": [ "amount", "precision", "transaction_id", "parent_transaction", "allow_overdraft", "infligt", "source", "destination", "reference", "currency", "description", "status", "hash", "created_at", "scheduled_for" ], "type": "object", "properties": { "amount": { "type": "integer", "format": "int32" }, "precision": { "type": "integer", "format": "int32" }, "transaction_id": { "type": "string" }, "parent_transaction": { "type": "string" }, "allow_overdraft": { "type": "boolean" }, "infligt": { "type": "boolean" }, "source": { "type": "string" }, "destination": { "type": "string" }, "reference": { "type": "string" }, "currency": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string" }, "hash": { "type": "string" }, "created_at": { "type": "string" }, "scheduled_for": { "type": "string" }, "inflight_expiry_date": { "type": "string" }, "inflight_commit_date": { "type": "string" } }, "example": { "amount": 74000, "precision": 0, "transaction_id": "txn_bd9ab37f-e353-450d-8210-1958bd50254a", "parent_transaction": "txn_bd9ab37f-e353-450d-8210-1958bd50254a", "allow_overdraft": false, "infligt": false, "source": "bln_8ab15e8f-da33-428f-b3f8-ab3d1c1dda09", "destination": "bln_76ceff93-fcac-47e0-84ee-88e086359064", "reference": "reference", "currency": "NGN", "description": "", "status": "APPLIED", "hash": "032af5e26c8a2c2690f1bb70bdd7c044bbdf9c7f5576fc0f693200baf65a9ee3", "created_at": "2024-04-07T08:20:06.494307542Z", "scheduled_for": "0001-01-01T00:00:00Z", "inflight_expiry_date": "0001-01-01T00:00:00Z", "inflight_commit_date": "0001-01-01T00:00:00Z" } }, "ScheduleTransactionRequest": { "title": "ScheduleTransactionRequest", "required": [ "amount", "tag", "reference", "currency", "source", "destination", "allow_over_draft", "scheduled_for" ], "type": "object", "properties": { "amount": { "type": "integer", "format": "int32" }, "tag": { "type": "string" }, "reference": { "type": "string" }, "currency": { "type": "string" }, "source": { "type": "string" }, "destination": { "type": "string" }, "allow_over_draft": { "type": "boolean" }, "scheduled_for": { "type": "string" } }, "example": { "precise_amount": 100000, "precision": 100, "tag": "hello", "reference": "Pt3744ee33errrddde3r222r3eee1", "currency": "NGN", "source": "@tax", "destination": "@firs", "allow_over_draft": true, "scheduled_for": "2025-10-06T12:00:00Z" } }, "ScheduleTransaction": { "title": "ScheduleTransaction", "required": [ "id", "tag", "reference", "amount", "currency", "payment_method", "description", "drcr", "status", "ledger_id", "balance_id", "credit_balance_before", "debit_balance_before", "credit_balance_after", "debit_balance_after", "balance_before", "balance_after", "created_at", "scheduled_for", "risk_tolerance_threshold", "risk_score", "group_ids" ], "type": "object", "properties": { "id": { "type": "string" }, "tag": { "type": "string" }, "reference": { "type": "string" }, "amount": { "type": "integer", "format": "int32" }, "currency": { "type": "string" }, "payment_method": { "type": "string" }, "description": { "type": "string" }, "drcr": { "type": "string" }, "status": { "type": "string" }, "ledger_id": { "type": "string" }, "balance_id": { "type": "string" }, "credit_balance_before": { "type": "integer", "format": "int32" }, "debit_balance_before": { "type": "integer", "format": "int32" }, "credit_balance_after": { "type": "integer", "format": "int32" }, "debit_balance_after": { "type": "integer", "format": "int32" }, "balance_before": { "type": "integer", "format": "int32" }, "balance_after": { "type": "integer", "format": "int32" }, "created_at": { "type": "string" }, "scheduled_for": { "type": "string" }, "risk_tolerance_threshold": { "type": "integer", "format": "int32" }, "risk_score": { "type": "number" }, "group_ids": { "type": "string", "nullable": true } }, "example": { "id": "txn_24ad5917-841a-405f-bad3-500d4c7e566a", "tag": "hello", "reference": "ref3", "amount": 300, "currency": "NGN", "payment_method": "", "description": "", "drcr": "Credit", "status": "SCHEDULED", "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "credit_balance_before": 600, "debit_balance_before": 0, "credit_balance_after": 900, "debit_balance_after": 0, "balance_before": 600, "balance_after": 900, "created_at": "2024-02-20T05:39:59.416068221Z", "scheduled_for": "2025-10-06T12:00:00Z", "risk_tolerance_threshold": 0, "risk_score": 0.00108, "group_ids": null } }, "RefundTransaction": { "title": "RefundTransaction", "required": [ "id", "tag", "reference", "amount", "currency", "payment_method", "description", "drcr", "status", "ledger_id", "balance_id", "credit_balance_before", "debit_balance_before", "credit_balance_after", "debit_balance_after", "balance_before", "balance_after", "created_at", "scheduled_for", "risk_tolerance_threshold", "risk_score", "meta_data", "group_ids" ], "type": "object", "properties": { "id": { "type": "string" }, "tag": { "type": "string" }, "reference": { "type": "string" }, "amount": { "type": "integer", "format": "int32" }, "currency": { "type": "string" }, "payment_method": { "type": "string" }, "description": { "type": "string" }, "drcr": { "type": "string" }, "status": { "type": "string" }, "ledger_id": { "type": "string" }, "balance_id": { "type": "string" }, "credit_balance_before": { "type": "integer", "format": "int32" }, "debit_balance_before": { "type": "integer", "format": "int32" }, "credit_balance_after": { "type": "integer", "format": "int32" }, "debit_balance_after": { "type": "integer", "format": "int32" }, "balance_before": { "type": "integer", "format": "int32" }, "balance_after": { "type": "integer", "format": "int32" }, "created_at": { "type": "string" }, "scheduled_for": { "type": "string" }, "risk_tolerance_threshold": { "type": "integer", "format": "int32" }, "risk_score": { "type": "number" }, "meta_data": { "$ref": "#/components/schemas/MetaData1" }, "group_ids": { "type": "string", "nullable": true } }, "example": { "id": "txn_043d4ac3-4caf-4149-9c0d-927ae637d83f", "tag": "Refund", "reference": "ref_70ffd90f-7bcf-43b8-90ba-70505c113b52", "amount": 300, "currency": "NGN", "payment_method": "", "description": "", "drcr": "Debit", "status": "APPLIED", "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "credit_balance_before": 600, "debit_balance_before": 0, "credit_balance_after": 600, "debit_balance_after": 300, "balance_before": 600, "balance_after": 300, "created_at": "2024-02-20T05:40:52.630481718Z", "scheduled_for": "0001-01-01T00:00:00Z", "risk_tolerance_threshold": 0, "risk_score": 0.03108, "meta_data": { "refunded_transaction_id": "txn_5bbbe4d3-2d82-4da1-8191-aaa491d025de" }, "group_ids": null } }, "MetaData1": { "title": "MetaData1", "required": [ "refunded_transaction_id" ], "type": "object", "properties": { "refunded_transaction_id": { "type": "string" } }, "example": { "refunded_transaction_id": "txn_5bbbe4d3-2d82-4da1-8191-aaa491d025de" } }, "CreateBalanceMonitorRequest": { "title": "CreateBalanceMonitorRequest", "required": [ "balance_id", "condition", "call_back_url" ], "type": "object", "properties": { "balance_id": { "type": "string" }, "condition": { "$ref": "#/components/schemas/Condition" }, "call_back_url": { "type": "string" } }, "example": { "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "condition": { "field": "debit_balance", "operator": ">", "value": 100000 }, "call_back_url": "https://api.myapp.com/balancemonitor" } }, "Condition": { "title": "Condition", "required": [ "field", "operator", "value" ], "type": "object", "properties": { "field": { "type": "string" }, "operator": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "example": { "field": "debit_balance", "operator": ">", "value": 100000 } }, "CreateBalanceMonitor": { "title": "CreateBalanceMonitor", "required": [ "monitor_id", "balance_id", "condition", "description", "call_back_url", "created_at" ], "type": "object", "properties": { "monitor_id": { "type": "string" }, "balance_id": { "type": "string" }, "condition": { "$ref": "#/components/schemas/Condition" }, "description": { "type": "string" }, "call_back_url": { "type": "string" }, "created_at": { "type": "string" } }, "example": { "monitor_id": "mon_e0e77b0c-4985-472a-9bf5-76a48b0259b0", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "condition": { "field": "debit_balance", "operator": ">", "value": 100000 }, "description": "", "call_back_url": "https://api.myapp.com/balancemonitor", "created_at": "2024-02-20T05:56:58.257315054Z" } }, "CreateIdentityRequest": { "title": "CreateIdentityRequest", "required": [ "identity_type", "name", "category", "street", "country", "state", "post_code", "city", "created_at", "meta_data" ], "type": "object", "properties": { "identity_type": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string" }, "street": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "post_code": { "type": "string" }, "city": { "type": "string" }, "created_at": { "type": "string" }, "meta_data": { "$ref": "#/components/schemas/MetaData2" } }, "example": { "identity_type": "organization", "name": "Blnk", "category": "fintech", "street": "10 Aso Villa Way", "country": "Nigeria", "state": "Lagos", "post_code": "101001", "city": "Lagos", "created_at": "2023-10-16T10:00:00Z", "meta_data": { "verified": true, "reference": "XYZ123456789" } } }, "MetaData2": { "title": "MetaData2", "required": [ "verified", "reference" ], "type": "object", "properties": { "verified": { "type": "boolean" }, "reference": { "type": "string" } }, "example": { "verified": true, "reference": "XYZ123456789" } }, "CreateIdentity": { "title": "CreateIdentity", "required": [ "identity_id", "identity_type", "organization_name", "category", "first_name", "last_name", "other_names", "gender", "dob", "email_address", "phone_number", "nationality", "street", "country", "state", "post_code", "city", "created_at", "meta_data" ], "type": "object", "properties": { "identity_id": { "type": "string" }, "identity_type": { "type": "string" }, "organization_name": { "type": "string" }, "category": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "other_names": { "type": "string" }, "gender": { "type": "string" }, "dob": { "type": "string" }, "email_address": { "type": "string" }, "phone_number": { "type": "string" }, "nationality": { "type": "string" }, "street": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "post_code": { "type": "string" }, "city": { "type": "string" }, "created_at": { "type": "string" }, "meta_data": { "$ref": "#/components/schemas/MetaData2" } }, "example": { "identity_id": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db", "identity_type": "organization", "organization_name": "", "category": "fintech", "first_name": "", "last_name": "", "other_names": "", "gender": "", "dob": "0001-01-01T00:00:00Z", "email_address": "", "phone_number": "", "nationality": "", "street": "10 Aso Villa Way", "country": "Nigeria", "state": "Lagos", "post_code": "101001", "city": "Lagos", "created_at": "2024-02-20T05:27:44.748526423Z", "meta_data": { "reference": "XYZ123456789", "verified": true } } }, "CreateAccountRequest": { "title": "CreateAccountRequest", "required": [ "bank_name", "number", "balance_id", "identity_id" ], "type": "object", "properties": { "bank_name": { "type": "string" }, "number": { "type": "string" }, "balance_id": { "type": "string" }, "identity_id": { "type": "string" } }, "example": { "bank_name": "Bknk bank", "number": "30888334", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "identity_id": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db" } }, "CreateAccount": { "title": "CreateAccount", "required": [ "account_id", "name", "number", "bank_name", "currency", "created_at", "balance_id", "identity_id", "ledger_id", "meta_data", "ledger", "balance", "identity" ], "type": "object", "properties": { "account_id": { "type": "string" }, "name": { "type": "string" }, "number": { "type": "string" }, "bank_name": { "type": "string" }, "currency": { "type": "string" }, "created_at": { "type": "string" }, "balance_id": { "type": "string" }, "identity_id": { "type": "string" }, "ledger_id": { "type": "string" }, "meta_data": { "type": "string", "nullable": true }, "ledger": { "type": "string", "nullable": true }, "balance": { "type": "string", "nullable": true }, "identity": { "type": "string", "nullable": true } }, "example": { "account_id": "acc_463b25b8-7b24-4e8b-aa49-7844d9074019", "name": "Chijioke Adeola", "number": "294364850431", "bank_name": "Blnk Bank", "currency": "NGN", "created_at": "2024-02-20T05:35:55.720731136Z", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "identity_id": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db", "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "meta_data": null, "ledger": null, "balance": null, "identity": null } }, "UpdateIdentityRequest": { "title": "UpdateIdentityRequest", "required": [ "identity_type", "first_name", "last_name", "other_names", "gender", "dob", "email_address", "phone_number", "nationality", "street", "country", "state", "post_code", "city", "created_at", "meta_data" ], "type": "object", "properties": { "identity_type": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "other_names": { "type": "string" }, "gender": { "type": "string" }, "dob": { "type": "string" }, "email_address": { "type": "string" }, "phone_number": { "type": "string" }, "nationality": { "type": "string" }, "street": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "post_code": { "type": "string" }, "city": { "type": "string" }, "created_at": { "type": "string" }, "meta_data": { "$ref": "#/components/schemas/MetaData2" } }, "example": { "identity_type": "individual", "first_name": "Chijioke", "last_name": "Adeola", "other_names": "Emeka", "gender": "male", "dob": "1990-01-01T00:00:00Z", "email_address": "chijioke.adeola@gmail.com", "phone_number": "+2347012345678", "nationality": "Nigerian", "street": "10 Aso Villa Way", "country": "Nigeria", "state": "Lagos", "post_code": "101001", "city": "Lagos", "created_at": "2023-10-16T10:00:00Z", "meta_data": { "verified": true, "reference": "XYZ123456789" } } }, "UpdateIdentity": { "title": "UpdateIdentity", "required": [ "message" ], "type": "object", "properties": { "message": { "type": "string" } }, "example": { "message": "Identity updated successfully" } }, "UpdateAccountRequest": { "title": "UpdateAccountRequest", "required": [ "bank_name", "number", "balance_id", "identity_id" ], "type": "object", "properties": { "bank_name": { "type": "string" }, "number": { "type": "string" }, "balance_id": { "type": "string" }, "identity_id": { "type": "string" } }, "example": { "bank_name": "Bknk bank MFB", "number": "30888334", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "identity_id": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db" } }, "UpdateBalanceMonitorRequest": { "title": "UpdateBalanceMonitorRequest", "required": [ "balance_id", "condition" ], "type": "object", "properties": { "balance_id": { "type": "string" }, "condition": { "$ref": "#/components/schemas/Condition" } }, "example": { "balance_id": "bln_c1750613-b4b0-4cde-9793-459165a8715f", "condition": { "field": "balance", "operator": "=", "value": 10000000 } } }, "CreateEvent": { "title": "CreateEvent", "required": [ "id", "tag", "reference", "amount", "currency", "payment_method", "description", "drcr", "status", "ledger_id", "balance_id", "credit_balance_before", "debit_balance_before", "credit_balance_after", "debit_balance_after", "balance_before", "balance_after", "created_at", "scheduled_for", "risk_tolerance_threshold", "risk_score", "group_ids" ], "type": "object", "properties": { "id": { "type": "string" }, "tag": { "type": "string" }, "reference": { "type": "string" }, "amount": { "type": "integer", "format": "int32" }, "currency": { "type": "string" }, "payment_method": { "type": "string" }, "description": { "type": "string" }, "drcr": { "type": "string" }, "status": { "type": "string" }, "ledger_id": { "type": "string" }, "balance_id": { "type": "string" }, "credit_balance_before": { "type": "integer", "format": "int32" }, "debit_balance_before": { "type": "integer", "format": "int32" }, "credit_balance_after": { "type": "integer", "format": "int32" }, "debit_balance_after": { "type": "integer", "format": "int32" }, "balance_before": { "type": "integer", "format": "int32" }, "balance_after": { "type": "integer", "format": "int32" }, "created_at": { "type": "string" }, "scheduled_for": { "type": "string" }, "risk_tolerance_threshold": { "type": "integer", "format": "int32" }, "risk_score": { "type": "number" }, "group_ids": { "type": "string", "nullable": true } }, "example": { "id": "txn_ea438725-e677-405c-9552-4c549837c622", "tag": "", "reference": "1jhbs3ozmen0k7y5e333feeme3rrr33ewwedffdew", "amount": 30000, "currency": "NGN", "payment_method": "", "description": "", "drcr": "Credit", "status": "QUEUED", "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "credit_balance_before": 600, "debit_balance_before": 300, "credit_balance_after": 30600, "debit_balance_after": 300, "balance_before": 300, "balance_after": 30300, "created_at": "2024-02-20T05:42:41.686457754Z", "scheduled_for": "0001-01-01T00:00:00Z", "risk_tolerance_threshold": 0, "risk_score": 0.12020571428571429, "group_ids": null } }, "GetBalance": { "title": "GetBalance", "required": [ "id", "name", "created_at" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "created_at": { "type": "string" } }, "example": { "id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "name": "Customer wallets Ledger", "created_at": "2024-02-20T05:28:03.563132Z" } }, "GetBalance1": { "title": "GetBalance1", "required": [ "balance_id", "balance", "credit_balance", "debit_balance", "currency", "ledger_id", "identity_id", "ledger", "created_at", "meta_data" ], "type": "object", "properties": { "balance_id": { "type": "string" }, "balance": { "type": "integer", "format": "int32" }, "credit_balance": { "type": "integer", "format": "int32" }, "debit_balance": { "type": "integer", "format": "int32" }, "currency": { "type": "string" }, "ledger_id": { "type": "string" }, "identity_id": { "type": "string" }, "ledger": { "$ref": "#/components/schemas/Ledger" }, "created_at": { "type": "string" }, "meta_data": { "type": "string", "nullable": true } }, "example": { "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "balance": 300, "credit_balance": 300, "debit_balance": 0, "currency": "NGN", "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "identity_id": "", "ledger": { "id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "name": "Customer wallets Ledger", "created_at": "2024-02-20T05:28:03.563132Z" }, "created_at": "2024-02-20T05:33:01.3116Z", "meta_data": null } }, "Ledger": { "title": "Ledger", "required": [ "ledger_id", "name", "created_at", "meta_data" ], "type": "object", "properties": { "ledger_id": { "type": "string" }, "name": { "type": "string" }, "created_at": { "type": "string" }, "meta_data": { "$ref": "#/components/schemas/MetaData" } }, "example": { "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "name": "Customer wallets Ledger", "created_at": "2024-02-20T05:28:03.563132Z", "meta_data": { "project_owner": "Blnk Tech" } } }, "GetBalanceMonitor": { "title": "GetBalanceMonitor", "required": [ "monitor_id", "balance_id", "condition", "description", "call_back_url", "created_at" ], "type": "object", "properties": { "monitor_id": { "type": "string" }, "balance_id": { "type": "string" }, "condition": { "$ref": "#/components/schemas/Condition" }, "description": { "type": "string" }, "call_back_url": { "type": "string" }, "created_at": { "type": "string" } }, "example": { "monitor_id": "mon_e0e77b0c-4985-472a-9bf5-76a48b0259b0", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "condition": { "field": "debit_balance", "operator": ">", "value": 100000 }, "description": "", "call_back_url": "https://api.myapp.com/balancemonitor", "created_at": "2024-02-20T05:56:58.257315Z" } }, "GetAccount": { "title": "GetAccount", "required": [ "account_id", "name", "number", "bank_name", "currency", "created_at", "balance_id", "identity_id", "ledger_id", "meta_data", "ledger", "balance", "identity" ], "type": "object", "properties": { "account_id": { "type": "string" }, "name": { "type": "string" }, "number": { "type": "string" }, "bank_name": { "type": "string" }, "currency": { "type": "string" }, "created_at": { "type": "string" }, "balance_id": { "type": "string" }, "identity_id": { "type": "string" }, "ledger_id": { "type": "string" }, "meta_data": { "$ref": "#/components/schemas/MetaData2" }, "ledger": { "$ref": "#/components/schemas/Ledger" }, "balance": { "$ref": "#/components/schemas/Balance" }, "identity": { "$ref": "#/components/schemas/Identity" } }, "example": { "account_id": "acc_463b25b8-7b24-4e8b-aa49-7844d9074019", "name": "Chijioke Adeola", "number": "294364850431", "bank_name": "Blnk Bank", "currency": "NGN", "created_at": "0001-01-01T00:00:00Z", "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "identity_id": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db", "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "meta_data": { "reference": "XYZ123456789", "verified": true }, "ledger": { "id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "name": "Customer wallets Ledger", "created_at": "2024-02-20T05:28:03.563132Z" }, "balance": { "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "balance": 30300, "credit_balance": 30600, "debit_balance": 300, "currency": "NGN", "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "identity_id": "", "created_at": "2024-02-20T05:33:01.3116Z", "meta_data": null }, "identity": { "identity_id": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db", "identity_type": "individual", "organization_name": "", "category": "", "first_name": "Chijioke", "last_name": "Adeola", "other_names": "Emeka", "gender": "male", "dob": "1990-01-01T00:00:00Z", "email_address": "chijioke.adeola@gmail.com", "phone_number": "+2347012345678", "nationality": "Nigerian", "street": "10 Aso Villa Way", "country": "Nigeria", "state": "Lagos", "post_code": "101001", "city": "Lagos", "created_at": "2023-10-16T10:00:00Z", "meta_data": null } } }, "Balance": { "title": "Balance", "required": [ "balance_id", "balance", "credit_balance", "debit_balance", "currency", "ledger_id", "identity_id", "created_at", "meta_data" ], "type": "object", "properties": { "balance_id": { "type": "string" }, "balance": { "type": "integer", "format": "int32" }, "credit_balance": { "type": "integer", "format": "int32" }, "debit_balance": { "type": "integer", "format": "int32" }, "currency": { "type": "string" }, "ledger_id": { "type": "string" }, "identity_id": { "type": "string" }, "created_at": { "type": "string" }, "meta_data": { "type": "string", "nullable": true } }, "example": { "balance_id": "bln_0be360ca-86fe-457d-be43-daa3f966d8f0", "balance": 30300, "credit_balance": 30600, "debit_balance": 300, "currency": "NGN", "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc", "identity_id": "", "created_at": "2024-02-20T05:33:01.3116Z", "meta_data": null } }, "Identity": { "title": "Identity", "required": [ "identity_id", "identity_type", "organization_name", "category", "first_name", "last_name", "other_names", "gender", "dob", "email_address", "phone_number", "nationality", "street", "country", "state", "post_code", "city", "created_at", "meta_data" ], "type": "object", "properties": { "identity_id": { "type": "string" }, "identity_type": { "type": "string" }, "organization_name": { "type": "string" }, "category": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "other_names": { "type": "string" }, "gender": { "type": "string" }, "dob": { "type": "string" }, "email_address": { "type": "string" }, "phone_number": { "type": "string" }, "nationality": { "type": "string" }, "street": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "post_code": { "type": "string" }, "city": { "type": "string" }, "created_at": { "type": "string" }, "meta_data": { "type": "string", "nullable": true } }, "example": { "identity_id": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db", "identity_type": "individual", "organization_name": "", "category": "", "first_name": "Chijioke", "last_name": "Adeola", "other_names": "Emeka", "gender": "male", "dob": "1990-01-01T00:00:00Z", "email_address": "chijioke.adeola@gmail.com", "phone_number": "+2347012345678", "nationality": "Nigerian", "street": "10 Aso Villa Way", "country": "Nigeria", "state": "Lagos", "post_code": "101001", "city": "Lagos", "created_at": "2023-10-16T10:00:00Z", "meta_data": null } }, "GetIdentity": { "title": "GetIdentity", "required": [ "identity_id", "identity_type", "organization_name", "category", "first_name", "last_name", "other_names", "gender", "dob", "email_address", "phone_number", "nationality", "street", "country", "state", "post_code", "city", "created_at", "meta_data" ], "type": "object", "properties": { "identity_id": { "type": "string" }, "identity_type": { "type": "string" }, "organization_name": { "type": "string" }, "category": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "other_names": { "type": "string" }, "gender": { "type": "string" }, "dob": { "type": "string" }, "email_address": { "type": "string" }, "phone_number": { "type": "string" }, "nationality": { "type": "string" }, "street": { "type": "string" }, "country": { "type": "string" }, "state": { "type": "string" }, "post_code": { "type": "string" }, "city": { "type": "string" }, "created_at": { "type": "string" }, "meta_data": { "$ref": "#/components/schemas/MetaData2" } }, "example": { "identity_id": "idt_0b5f333d-e0b8-4422-8e0e-5d41a767f1db", "identity_type": "individual", "organization_name": "", "category": "", "first_name": "Chijioke", "last_name": "Adeola", "other_names": "Emeka", "gender": "male", "dob": "1990-01-01T00:00:00Z", "email_address": "chijioke.adeola@gmail.com", "phone_number": "+2347012345678", "nationality": "Nigerian", "street": "10 Aso Villa Way", "country": "Nigeria", "state": "Lagos", "post_code": "101001", "city": "Lagos", "created_at": "2023-10-16T10:00:00Z", "meta_data": { "reference": "XYZ123456789", "verified": true } } } }, "securitySchemes": { "basic": { "type": "http", "scheme": "basic" } } }, "security": [], "tags": [ { "name": "Misc", "description": "" } ] }