Account

Methods for managing accounts, deployments, callback secrets, and balance summaries in B2BINPAY DeFi API

Get list

get

Get list of entities

Authorizations

ApiKeyAuth

x-api-keystringRequired

Provide API key in X-API-Key header

Responses

200

Entity retrieved successfully

application/json

idstringRequired

Entity unique identifier

Example: 123e4567-e89b-12d3-a456-426614174000

namestringRequired

Account display name

Example: Marketing Team

contractstringRequired

Multisig contract address

Example: 0x1234567890123456789012345678901234567890

membersstring[]Required

All account members aggregated from all networks (read access)

Example: ["0x1111111111111111111111111111111111111111","0x2222222222222222222222222222222222222222"]

createdAtstringRequired

Creation timestamp

Example: 2024-01-01T00:00:00.000Z

isTronbooleanRequired

Whether the entity relates to Tron (TVM)

Example: false

401

Invalid or missing token

get

/api/v1/accounts

HTTPcURLJavaScriptPython

GET /api/v1/accounts HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Marketing Team",
    "contract": "0x1234567890123456789012345678901234567890",
    "members": [
      "0x1111111111111111111111111111111111111111",
      "0x2222222222222222222222222222222222222222"
    ],
    "createdAt": "2024-01-01T00:00:00.000Z",
    "initialConfig": {
      "members": [
        "0x1111111111111111111111111111111111111111",
        "0x2222222222222222222222222222222222222222"
      ],
      "threshold": 1,
      "nonce": "0xa1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef12345678"
    },
    "isTron": false
  }
]

Get by ID

get

Get entity by ID

Authorizations

ApiKeyAuth

x-api-keystringRequired

Provide API key in X-API-Key header

Path parameters

accountIdstring · uuidRequired

Account unique identifier

Example: 123e4567-e89b-12d3-a456-426614174000

Responses

200

Entity retrieved successfully

application/json

401

Invalid or missing token

404

[ERR_404] Account not found

get

/api/v1/accounts/{accountId}

HTTPcURLJavaScriptPython

GET /api/v1/accounts/{accountId} HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

{
  "account": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Marketing Team",
    "contract": "0x1234567890123456789012345678901234567890",
    "members": [
      "0x1111111111111111111111111111111111111111",
      "0x2222222222222222222222222222222222222222"
    ],
    "createdAt": "2024-01-01T00:00:00.000Z",
    "initialConfig": {
      "members": [
        "0x1111111111111111111111111111111111111111",
        "0x2222222222222222222222222222222222222222"
      ],
      "threshold": 1,
      "nonce": "0xa1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef12345678"
    },
    "isTron": false
  },
  "deployments": [
    {
      "deploymentId": "123e4567-e89b-12d3-a456-426614174000",
      "chainId": "1",
      "networkName": "Ethereum Mainnet",
      "approvers": [
        "0x1111111111111111111111111111111111111111",
        "0x2222222222222222222222222222222222222222"
      ],
      "threshold": 1,
      "deploymentStatus": "pending",
      "transactionHash": "0x777...",
      "deployedAt": "2024-01-16T14:20:00Z"
    }
  ]
}

Update

put

Update entity

Authorizations

ApiKeyAuth

x-api-keystringRequired

Provide API key in X-API-Key header

Path parameters

accountIdstring · uuidRequired

Account unique identifier

Example: 123e4567-e89b-12d3-a456-426614174000

Body

application/json

namestring · min: 1 · max: 255Required

Responses

200

Entity updated successfully

application/json

idstringRequired

Entity unique identifier

Example: 123e4567-e89b-12d3-a456-426614174000

namestringRequired

Account display name

Example: Marketing Team

contractstringRequired

Multisig contract address

Example: 0x1234567890123456789012345678901234567890

membersstring[]Required

All account members aggregated from all networks (read access)

Example: ["0x1111111111111111111111111111111111111111","0x2222222222222222222222222222222222222222"]

createdAtstringRequired

Creation timestamp

Example: 2024-01-01T00:00:00.000Z

isTronbooleanRequired

Whether the entity relates to Tron (TVM)

Example: false

400

Invalid input

401

Invalid or missing token

404

[ERR_404] Account not found

put

/api/v1/accounts/{accountId}

HTTPcURLJavaScriptPython

PUT /api/v1/accounts/{accountId} HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Marketing Team",
  "contract": "0x1234567890123456789012345678901234567890",
  "members": [
    "0x1111111111111111111111111111111111111111",
    "0x2222222222222222222222222222222222222222"
  ],
  "createdAt": "2024-01-01T00:00:00.000Z",
  "initialConfig": {
    "members": [
      "0x1111111111111111111111111111111111111111",
      "0x2222222222222222222222222222222222222222"
    ],
    "threshold": 1,
    "nonce": "0xa1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef12345678"
  },
  "isTron": false
}

Get deployment params

get

Get parameters required to deploy the team including bytecode, initializer bytecode, and nonce

Authorizations

ApiKeyAuth

x-api-keystringRequired

Provide API key in X-API-Key header

Path parameters

accountIdstring · uuidRequired

Account unique identifier

Example: 123e4567-e89b-12d3-a456-426614174000

Responses

200

Deployment parameters retrieved successfully

application/json

implementationAddressstringRequired

Implementation address to copy

Example: 0x1234567890...

initializerBytecodestringRequired

Initializer bytecode with encoded constructor parameters

Example: 0x1234567890...

noncestringRequired

Nonce for uniq deployment

Example: 0x1234567890...

deployerAddressstringRequired

Deployer address for contract deployment

Example: 0x1234567890...

401

Invalid or missing token

404

[ERR_404] Account not found

get

/api/v1/accounts/{accountId}/deploy-params

HTTPcURLJavaScriptPython

GET /api/v1/accounts/{accountId}/deploy-params HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

{
  "implementationAddress": "0x1234567890...",
  "initializerBytecode": "0x1234567890...",
  "nonce": "0x1234567890...",
  "deployerAddress": "0x1234567890..."
}

Generate callback secret

post

Generates a new callback secret for the account. The secret is returned only once and instantly invalidates the old secret.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Provide API key in X-API-Key header

Path parameters

accountIdstring · uuidRequired

Account unique identifier

Example: 123e4567-e89b-12d3-a456-426614174000

Responses

201

Callback secret generated successfully

application/json

400

Invalid input

401

Invalid or missing token

404

[ERR_404] Account not found

post

/api/v1/accounts/{accountId}/callback-secret

HTTPcURLJavaScriptPython

POST /api/v1/accounts/{accountId}/callback-secret HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

{
  "secret": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Get balance summary

get

Returns total balance, uncollected balance and count of uncollected invoices for a team on a specific network

Authorizations

ApiKeyAuth

x-api-keystringRequired

Provide API key in X-API-Key header

Path parameters

accountIdstring · uuidRequired

Account unique identifier

Example: 123e4567-e89b-12d3-a456-426614174000

Query parameters

baseCurrencystring · enumRequired

Base currency for conversion

Example: usdPossible values:

chainIdstring · int64Required

Blockchain network chain ID

Example: 1

Responses

200

Balance summary retrieved successfully

application/json

totalBalancenumberRequired

Total balance in base currency

Example: 150000

uncollectedBalancenumberRequired

Uncollected balance in base currency

Example: 32000

uncollectedInvoicesnumberRequired

Count of uncollected invoices

Example: 5

allRatesReceivedbooleanRequired

Whether all currency rates were available

Example: true

401

Invalid or missing token

404

[ERR_404] Account not found

get

/api/v1/accounts/{accountId}/balance/summary

HTTPcURLJavaScriptPython

GET /api/v1/accounts/{accountId}/balance/summary?baseCurrency=usd&chainId=1 HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

{
  "totalBalance": 150000,
  "uncollectedBalance": 32000,
  "uncollectedInvoices": 5,
  "allRatesReceived": true
}

Get asset balances

get

Returns balances for each asset with conversion to base currency for a specific network with pagination

Authorizations

ApiKeyAuth

x-api-keystringRequired

Provide API key in X-API-Key header

Path parameters

accountIdstring · uuidRequired

Account unique identifier

Example: 123e4567-e89b-12d3-a456-426614174000

Query parameters

baseCurrencystring · enumRequired

Base currency for conversion

Example: usdPossible values:

chainIdstring · int64Required

Blockchain network chain ID

Example: 1

sortBystring · enumOptional

Field to sort by

Default: balanceExample: idPossible values:

sortOrderstring · enumOptional

Sort order (ascending or descending)

Default: descExample: descPossible values:

currencyIdsone ofOptional

Filter by currency IDs

Example: ["1-0xdac17f958d2ee523a2206206994597c13d831ec7","1-0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"]

string · min: 1Optional

or

string[]Optional

pagenumberOptional

Page number (starts from 1)

Default: 1Example: 1

pageSizenumber · max: 100Optional

Number of items per page (max 100)

Default: 10Example: 10

Responses

200

Asset balances retrieved successfully

application/json

totalnumberRequired

Total number of items across all pages

pagenumberRequired

Current page number (starts from 1)

pageSizenumberRequired

Number of items per page

401

Invalid or missing token

404

[ERR_404] Account not found

get

/api/v1/accounts/{accountId}/balance/assets

HTTPcURLJavaScriptPython

GET /api/v1/accounts/{accountId}/balance/assets?baseCurrency=usd&chainId=1 HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

{
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "items": [
    {
      "currency": {
        "id": "1-0xdac17f958d2ee523a2206206994597c13d831ec7",
        "symbol": "USDT",
        "name": "Tether USD",
        "chainId": "1",
        "address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
        "decimals": 18,
        "isScam": false,
        "isVerified": true
      },
      "balance": 2.5,
      "convertedBalance": 162500
    }
  ]
}

Get nonce information

get

Returns current nonce and last executed nonce for the deployment

Authorizations

ApiKeyAuth

x-api-keystringRequired

Provide API key in X-API-Key header

Path parameters

deploymentIdstring · uuidRequired

UUID

Example: 123e4567-e89b-12d3-a456-426614174000

Responses

200

Nonce information retrieved successfully

application/json

currentNoncenumberRequired

Current nonce for this deployment - next transaction will use this nonce

Example: 5

lastExecutedNoncenumberRequired

Last executed nonce for this deployment (-1 if no transactions executed)

Example: 4

401

Invalid or missing token

404

[ERR_404] Deployment not found

get

/api/v1/accounts/deployments/{deploymentId}/nonce-info

HTTPcURLJavaScriptPython

GET /api/v1/accounts/deployments/{deploymentId}/nonce-info HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

{
  "currentNonce": 5,
  "lastExecutedNonce": 4
}