{ "openapi": "3.0.0", "info": { "title": "BITNOB API", "version": "1.0.0" }, "servers": [ { "url": "{{api_url}}" } ], "paths": { "/transactions": { "get": { "tags": [ "Transactions" ], "summary": "Get Transactions", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/transactions/c103b12c-9374-48a8-877b-0aa4471e7f5d": { "get": { "tags": [ "Transactions" ], "summary": "Get Transaction By ID", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" }, { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/wallets": { "get": { "tags": [ "Wallets" ], "summary": "Get Wallest", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/transfers": { "post": { "tags": [ "Transfer" ], "summary": "Initiate Transfer", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/transfers/finalize": { "post": { "tags": [ "Transfer" ], "summary": "Finalize Transfer", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/customers": { "post": { "tags": [ "Customers" ], "summary": "Create Customers", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "firstName": "Jane", "lastName": "Doe", "email": "jane@example.com", "phone": "08123456789", "countryCode": "+234" } } } } }, "get": { "tags": [ "Customers" ], "summary": "Get customer", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/customers/379de0fe-dc09-41f0-a4e8-c3d3745e2077": { "put": { "tags": [ "Customers" ], "summary": "Update Customer", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "firstName": "Christian", "lastName": "Arthur", "email": "chris@gmail.com", "phone": "08123456789", "countryCode": "+234" } } } } } }, "/customers/blacklist/379de0fe-dc09-41f0-a4e8-c3d3745e2077": { "put": { "tags": [ "Customers" ], "summary": "Blacklist customer", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/addresses": { "get": { "tags": [ "Address" ], "summary": "GET Address", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/addresses/2ada3fae-3370-42e5-924c-7831d0f2120a": { "get": { "tags": [ "Address" ], "summary": "GET Address By ID", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/addresses/validate": { "post": { "tags": [ "Address" ], "summary": "Validate Address", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "address": "" } } } } } }, "/addresses/generate": { "post": { "tags": [ "Address" ], "summary": "Generate Address", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "customerEmail": "chris@gmail.com" } } } } } }, "/virtual-cards/registercarduser": { "post": { "tags": [ "Cards" ], "summary": "Register Card User", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "customerEmail": "jane@example.com", "idNumber": "A1234567891", "idType": "PASSPORT", "firstName": "John", "lastName": "Doe", "country": "Nigeria", "phoneNumber": "+2348012345678", "city": "Lagos", "state": "Lagos", "zipCode": "100001", "line1": "123 Banana Island Rd", "houseName": "Sunset Apartments", "bvn": "1234567890111", "userPhoto": "https://example.com/photos/john.jpg", "dateOfBirth": "1990-01-01", "idImage": "https://example.com/ids/john_passport.jpg" } } } } } }, "/virtual-cards/users/75709708-bd5b-442d-bbc2-bce325a80b26": { "put": { "tags": [ "Cards" ], "summary": "Update Card User", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" }, { "name": "", "in": "header", "required": true, "schema": { "type": "string" }, "example": "" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "phoneNumber": "+233501234567", "country": "Ghana", "state": "Greater Accra", "city": "Accra", "zipCode": "233", "line1": "blue light line" } } } } } }, "/virtualcards/create": { "post": { "tags": [ "Cards" ], "summary": "Create card", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "customerEmail": "jane@example.com", "cardBrand": "visa", "cardType": "virtual", "amount": 300, "reference": "gift" } } } } } }, "/virtualcards/cards/fab06b35-8940-4a02-98e7-9dd2efb16abb": { "get": { "tags": [ "Cards" ], "summary": "Fetch Card User", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/virtualcards/cards/fab06b35-8940-4a02-98e7-9dd2efb16abb/transactions": { "get": { "tags": [ "Cards" ], "summary": "List Transactions On Card", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/virtualcards/transactions": { "get": { "tags": [ "Cards" ], "summary": "List Card Transactions", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/virtualcards/withdraw": { "post": { "tags": [ "Cards" ], "summary": "Card Withdrawal", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "amount": 400, "cardId": "7c495813-8bdc-4803-b1f2-8b37c55aa7b1", "reference": "gift" } } } } } }, "/virtualcards/freeze": { "post": { "tags": [ "Cards" ], "summary": "Freeze Card", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "cardId": "fab06b35-8940-4a02-98e7-9dd2efb16abb" } } } } } }, "/virtualcards/unfreeze": { "post": { "tags": [ "Cards" ], "summary": "Unfreeze Card", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "cardId": "fab06b35-8940-4a02-98e7-9dd2efb16abb" } } } } } }, "/virtualcards/mock-transaction": { "post": { "tags": [ "Cards" ], "summary": "Mock Transaction", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "amount": 100, "cardId": "fab06b35-8940-4a02-98e7-9dd2efb16abb" } } } } } }, "/virtualcards/terminate": { "post": { "tags": [ "Cards" ], "summary": "Terminate Card", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "cardId": "fab06b35-8940-4a02-98e7-9dd2efb16abb" } } } } } }, "/virtualcards/enable-airlines": { "put": { "tags": [ "Cards" ], "summary": "Enable Airline Payment", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "cardId": "fab06b35-8940-4a02-98e7-9dd2efb16abb", "isAirlinePaymentEnabled": true } } } } } }, "/payouts/quotes": { "post": { "tags": [ "Payout" ], "summary": "Payouts Quote", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "source": "onchain", "fromAsset": "usdt", "toCurrency": "ngn", "chain": "polygon", "amount": 20000 } } } } } }, "/payouts/initialize": { "post": { "tags": [ "Payout" ], "summary": "Initialize Payout", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "quoteId": "QT_121995", "customerId": "uuid string", "country": "NG", "reference": "ref_QT_OF_RM-123", "beneficiary": { "type": "BANK", "bankCode": "110072", "accountNumber": "1421795566" }, "paymentReason": "Funds for stuff", "callbackUrl": "https://example.com/callback/id", "clientMetaData": { "name": "john doe", "height": "194" } } } } } } }, "/payouts/finalize": { "post": { "tags": [ "Payout" ], "summary": "Finalize Payouts", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "quoteId": "QT_121995" } } } } } }, "/payouts/simulate-address-deposit": { "post": { "tags": [ "Payout" ], "summary": "Simulate Address Deposit", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "address": "0x8b425fa3ae405c54f1fcaa16b1981c173b66a2e8", "amount": 200 } } } } } }, "/payouts": { "get": { "tags": [ "Payout" ], "summary": "Get All Payout", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "address": "0x8b425fa3ae405c54f1fcaa16b1981c173b66a2e8", "amount": 200 } } } } } }, "/payouts/quotes/QT_121995": { "get": { "tags": [ "Payout" ], "summary": "Get Payout By Quote ID", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/payouts/fetch/4d808ea1-0d16-419c-b545-881821c3e904": { "get": { "tags": [ "Payout" ], "summary": "Get Payout By ID", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/payouts/fetch/reference/ref_QT_OF_RM-123": { "get": { "tags": [ "Payout" ], "summary": "Get Payout By Reference", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/payouts/supported-countries-requirement/Kenya": { "get": { "tags": [ "Payout" ], "summary": "Get Payout Country", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/trade": { "post": { "tags": [ "Trade" ], "summary": "Initialize Trading", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "amount": 1000 } } } } } }, "/trade/finalize": { "post": { "tags": [ "Trade" ], "summary": "Finalize Trade", "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "quoteId": "", "amount": 1000, "reference": "" } } } } } }, "/wallets/ln/createinvoice": { "post": { "tags": [ "Lightning" ], "summary": "Create Lightning Invoice", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "description": "l", "satoshis": 100 } } } } } }, "/wallets/ln/initiatepayment": { "post": { "tags": [ "Lightning" ], "summary": "Initialize Lightning Payment", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "request": "lnbc1u1p5vrrclpp5v8r3wxjrsmsrxmdnrrz9qrky7jllhfyyunvdk0fzwna9t0w596zqdqzdscqzzsxqyz5vqsp5anvttve45fc6nkf80fqerlwxxde2ws2sztltekf0fyywzwxjgaps9qxpqysgq0dy9k88xgz4rw3uh6cnrf5x6j07kkx3v6le3lkwzd4fl3ncdxrdxwe8qxwpy3y3syjxlpl2gyttu5eajn6u4qr2wa8usywmftff6rkgqkhc8ve" } } } } } }, "/wallets/ln/pay": { "post": { "tags": [ "Lightning" ], "summary": "Pay lightning Invoice", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": { "request": "lnbc1u1p5vrrclpp5v8r3wxjrsmsrxmdnrrz9qrky7jllhfyyunvdk0fzwna9t0w596zqdqzdscqzzsxqyz5vqsp5anvttve45fc6nkf80fqerlwxxde2ws2sztltekf0fyywzwxjgaps9qxpqysgq0dy9k88xgz4rw3uh6cnrf5x6j07kkx3v6le3lkwzd4fl3ncdxrdxwe8qxwpy3y3syjxlpl2gyttu5eajn6u4qr2wa8usywmftff6rkgqkhc8ve", "customerEmail": "customer@email.com", "transactionPin": "146151" } } } } } }, "/lightning/decode": { "post": { "tags": [ "Lightning" ], "summary": "Decode Lightning Invoice", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string" }, "example": "{{api_key}}" } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object" } } } } } } } } }