{
  "info": {
    "_postman_id": "1c1615d4-f436-4c6c-a146-1b7eedefdb67",
    "name": "Bitmessa API",
    "description": "# Bitmessa Partner API\n\nConvert BTC and USDT to Naira programmatically. This specification documents\nthe public Partner API for external integrations \u2014 admin, referral, earn,\nand internal operations endpoints are intentionally excluded.\n\n## Features\n\n- Real-time exchange rates\n- Payment lifecycle (create, track, finalize)\n- Bank account resolution and assignment\n- Transaction history\n- Webhook notifications\n- Public health and fee-rate endpoints\n",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://api.bitmessa.com"
    },
    {
      "key": "apiKey",
      "value": "your_api_key_here"
    }
  ],
  "item": [
    {
      "name": "Accounts",
      "item": [
        {
          "name": "Resolve bank account",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json",
                "type": "text"
              },
              {
                "key": "secretkey",
                "value": "{{apiKey}}",
                "type": "text"
              },
              {
                "key": "Content-Type",
                "value": "application/json",
                "type": "text"
              }
            ],
            "url": {
              "raw": "https://api.bitmessa.com/account-resolve",
              "host": [
                "api.bitmessa.com"
              ],
              "path": [
                "account-resolve"
              ],
              "query": null
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"account_number\": \"your_account_number\",\n  \"bank_code\": \"your_bank_code\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Resolves bank account details using account number and bank code."
          },
          "response": []
        },
        {
          "name": "Assign account to payment",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json",
                "type": "text"
              },
              {
                "key": "secretkey",
                "value": "{{apiKey}}",
                "type": "text"
              },
              {
                "key": "Content-Type",
                "value": "application/json",
                "type": "text"
              }
            ],
            "url": {
              "raw": "https://api.bitmessa.com/account/assign/{payment_id}",
              "host": [
                "api.bitmessa.com"
              ],
              "path": [
                "account",
                "assign",
                "{payment_id}"
              ],
              "query": null
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"account_id\": \"your_account_id\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Assigns a bank account to a specific payment."
          },
          "response": []
        },
        {
          "name": "Get account details",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json",
                "type": "text"
              },
              {
                "key": "secretkey",
                "value": "{{apiKey}}",
                "type": "text"
              }
            ],
            "url": {
              "raw": "https://api.bitmessa.com/account/{id}",
              "host": [
                "api.bitmessa.com"
              ],
              "path": [
                "account",
                "{id}"
              ],
              "query": null
            },
            "body": null,
            "description": "Returns details of a specific bank account."
          },
          "response": []
        },
        {
          "name": "List user bank accounts",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json",
                "type": "text"
              },
              {
                "key": "secretkey",
                "value": "{{apiKey}}",
                "type": "text"
              }
            ],
            "url": {
              "raw": "https://api.bitmessa.com/accounts",
              "host": [
                "api.bitmessa.com"
              ],
              "path": [
                "accounts"
              ],
              "query": null
            },
            "body": null,
            "description": "Returns a list of bank accounts for the authenticated user."
          },
          "response": []
        },
        {
          "name": "Get bank list",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json",
                "type": "text"
              },
              {
                "key": "secretkey",
                "value": "{{apiKey}}",
                "type": "text"
              }
            ],
            "url": {
              "raw": "https://api.bitmessa.com/banks/get",
              "host": [
                "api.bitmessa.com"
              ],
              "path": [
                "banks",
                "get"
              ],
              "query": null
            },
            "body": null,
            "description": "Returns a list of supported Nigerian banks."
          },
          "response": []
        }
      ]
    },
    {
      "name": "Fees",
      "item": [
        {
          "name": "Get Bitcoin fee rates",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json",
                "type": "text"
              }
            ],
            "url": {
              "raw": "https://api.bitmessa.com/bitcoin/public/currentfeerates",
              "host": [
                "api.bitmessa.com"
              ],
              "path": [
                "bitcoin",
                "public",
                "currentfeerates"
              ],
              "query": null
            },
            "body": null,
            "description": "Returns current Bitcoin network fee rates. Public endpoint \u2014 no authentication required.\nUseful for estimating confirmation times when building payment integrations."
          },
          "response": []
        }
      ]
    },
    {
      "name": "Health",
      "item": [
        {
          "name": "System health check",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json",
                "type": "text"
              }
            ],
            "url": {
              "raw": "https://api.bitmessa.com/health",
              "host": [
                "api.bitmessa.com"
              ],
              "path": [
                "health"
              ],
              "query": null
            },
            "body": null,
            "description": "Returns basic system health status"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Payments",
      "item": [
        {
          "name": "Create a new payment",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json",
                "type": "text"
              },
              {
                "key": "secretkey",
                "value": "{{apiKey}}",
                "type": "text"
              },
              {
                "key": "Content-Type",
                "value": "application/json",
                "type": "text"
              }
            ],
            "url": {
              "raw": "https://api.bitmessa.com/payment",
              "host": [
                "api.bitmessa.com"
              ],
              "path": [
                "payment"
              ],
              "query": null
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"amount\": 0.001,\n  \"currency\": \"BTC\",\n  \"bank_account\": \"your_bank_account\",\n  \"bank_name\": \"your_bank_name\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Creates a new payment request to convert BTC or USDT to Naira."
          },
          "response": []
        },
        {
          "name": "Finalize payment",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json",
                "type": "text"
              },
              {
                "key": "secretkey",
                "value": "{{apiKey}}",
                "type": "text"
              },
              {
                "key": "Content-Type",
                "value": "application/json",
                "type": "text"
              }
            ],
            "url": {
              "raw": "https://api.bitmessa.com/payment/finalize/{id}",
              "host": [
                "api.bitmessa.com"
              ],
              "path": [
                "payment",
                "finalize",
                "{id}"
              ],
              "query": null
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"bank_account\": \"your_bank_account\",\n  \"bank_name\": \"your_bank_name\",\n  \"account_name\": \"your_account_name\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Finalizes a payment with bank account details."
          },
          "response": []
        },
        {
          "name": "Search payment (public)",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json",
                "type": "text"
              }
            ],
            "url": {
              "raw": "https://api.bitmessa.com/payment/search/{id}",
              "host": [
                "api.bitmessa.com"
              ],
              "path": [
                "payment",
                "search",
                "{id}"
              ],
              "query": null
            },
            "body": null,
            "description": "Returns details of a specific payment (public access)."
          },
          "response": []
        },
        {
          "name": "Get payment details",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json",
                "type": "text"
              },
              {
                "key": "secretkey",
                "value": "{{apiKey}}",
                "type": "text"
              }
            ],
            "url": {
              "raw": "https://api.bitmessa.com/payment/{id}",
              "host": [
                "api.bitmessa.com"
              ],
              "path": [
                "payment",
                "{id}"
              ],
              "query": null
            },
            "body": null,
            "description": "Returns details of a specific payment (authenticated access)."
          },
          "response": []
        },
        {
          "name": "List user payments",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json",
                "type": "text"
              },
              {
                "key": "secretkey",
                "value": "{{apiKey}}",
                "type": "text"
              }
            ],
            "url": {
              "raw": "https://api.bitmessa.com/payments",
              "host": [
                "api.bitmessa.com"
              ],
              "path": [
                "payments"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "limit",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "status",
                  "value": "",
                  "disabled": true
                }
              ]
            },
            "body": null,
            "description": "Returns a list of payments for the authenticated user."
          },
          "response": []
        }
      ]
    },
    {
      "name": "Rates",
      "item": [
        {
          "name": "Get current exchange rates",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json",
                "type": "text"
              }
            ],
            "url": {
              "raw": "https://api.bitmessa.com/get/rate",
              "host": [
                "api.bitmessa.com"
              ],
              "path": [
                "get",
                "rate"
              ],
              "query": null
            },
            "body": null,
            "description": "Returns the current exchange rates for BTC and USDT to Naira.\nThis is the main rate endpoint used by the platform."
          },
          "response": []
        },
        {
          "name": "Get current exchange rates (commercial API)",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json",
                "type": "text"
              },
              {
                "key": "secretkey",
                "value": "{{apiKey}}",
                "type": "text"
              }
            ],
            "url": {
              "raw": "https://api.bitmessa.com/rates/current",
              "host": [
                "api.bitmessa.com"
              ],
              "path": [
                "rates",
                "current"
              ],
              "query": [
                {
                  "key": "currency",
                  "value": "",
                  "disabled": true
                }
              ]
            },
            "body": null,
            "description": "Returns the current exchange rates for BTC and USDT to Naira.\nRates are updated every minute."
          },
          "response": []
        }
      ]
    },
    {
      "name": "Transactions",
      "item": [
        {
          "name": "Get transaction details",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json",
                "type": "text"
              },
              {
                "key": "secretkey",
                "value": "{{apiKey}}",
                "type": "text"
              }
            ],
            "url": {
              "raw": "https://api.bitmessa.com/transaction/{id}",
              "host": [
                "api.bitmessa.com"
              ],
              "path": [
                "transaction",
                "{id}"
              ],
              "query": null
            },
            "body": null,
            "description": "Returns details of a specific transaction."
          },
          "response": []
        },
        {
          "name": "List user transactions",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json",
                "type": "text"
              },
              {
                "key": "secretkey",
                "value": "{{apiKey}}",
                "type": "text"
              }
            ],
            "url": {
              "raw": "https://api.bitmessa.com/transactions",
              "host": [
                "api.bitmessa.com"
              ],
              "path": [
                "transactions"
              ],
              "query": [
                {
                  "key": "page",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "limit",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "status",
                  "value": "",
                  "disabled": true
                },
                {
                  "key": "currency",
                  "value": "",
                  "disabled": true
                }
              ]
            },
            "body": null,
            "description": "Returns a list of transactions for the authenticated user."
          },
          "response": []
        }
      ]
    },
    {
      "name": "Webhooks",
      "item": [
        {
          "name": "Register a webhook",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Accept",
                "value": "application/json",
                "type": "text"
              },
              {
                "key": "secretkey",
                "value": "{{apiKey}}",
                "type": "text"
              },
              {
                "key": "Content-Type",
                "value": "application/json",
                "type": "text"
              }
            ],
            "url": {
              "raw": "https://api.bitmessa.com/webhooks",
              "host": [
                "api.bitmessa.com"
              ],
              "path": [
                "webhooks"
              ],
              "query": null
            },
            "body": {
              "mode": "raw",
              "raw": "{\n  \"url\": \"your_url\",\n  \"events\": \"your_events\",\n  \"secret\": \"your_secret\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "description": "Registers a new webhook to receive notifications for specific events."
          },
          "response": []
        }
      ]
    }
  ]
}