API docs by Redocly

Bitflow Merchant HTTP API (1.0)

Download OpenAPI specification:

This is the HTTP API for the Bitflow service.

Invoices

Get Invoice by ID

Retrieves the details of a specific invoice by its ID.

Authorizations:
APIKeyAuth
path Parameters
id
required
string

Invoice ID

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "status_code": 200
}

Create Invoice

Creates a new invoice for the authenticated merchant.

Authorizations:
APIKeyAuth
Request Body schema: application/json
required

Invoice creation request

base_amount
string
base_currency_code
string
description
string
expires_at
string
external_id
string

Responses

Request samples

Content type
application/json
{
  • "base_amount": "123.45",
  • "base_currency_code": "USD",
  • "description": "Payment for goods",
  • "expires_at": "2025-01-02 15:00:00.000000000",
  • "external_id": "order-5678"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "status_code": 200
}

Merchants

Get Current Merchant

Retrieves the profile of the currently authenticated merchant.

Authorizations:
APIKeyAuth

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "status": "success",
  • "status_code": 200
}

Get Merchant Accounts

Retrieves a list of accounts belonging to the currently authenticated merchant.

Authorizations:
APIKeyAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "status": "success",
  • "status_code": 200
}

Transfers

Execute a Transfer

Executes a new transfer from one of the merchant's accounts.

Authorizations:
APIKeyAuth
Request Body schema: application/json
required

Transfer execution request

account_id
string <uuid>
amount
string
object (UserPublicInfo)

Responses

Request samples

Content type
application/json
{
  • "account_id": "d1b2c3d4-e5f6-a7b8-c9d0-e1f2a3b4c5d6",
  • "amount": "50.25",
  • "recipient": {
    }
}

Response samples

Content type
application/json
{
  • "data": { },
  • "status": "success",
  • "status_code": 200
}