Transactions

Methods for listing and retrieving transactions in B2BINPAY DeFi API

Get list

get

Get list of entities

Authorizations

ApiKeyAuth

x-api-keystringRequired

Provide API key in X-API-Key header

Path parameters

deploymentIdstring · uuidRequired

Deployment unique identifier

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

Query parameters

idstringOptional

Filter by specific transaction ID

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

operationIdstringOptional

Filter by operation ID (same as invoiceId)

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

operationTypesone ofOptional

Filter by operation type

Example: ["invoice","claim"]

string · enumOptionalPossible values:

or

statusesone ofOptional

Filter by transaction statuses (multiselect)

Example: ["EXECUTED","PENDING"]

string · enumOptionalPossible values:

or

txHashstringOptional

Filter by transaction hash (text includes)

Example: 0x1234567890abcdef

currencyIdsone ofOptional

Filter by currency IDs

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

string · min: 1Optional

or

string[]Optional

createdFromstringOptional

Filter transactions created after this date (ISO 8601)

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

createdTostringOptional

Filter transactions created before this date (ISO 8601)

Example: 2024-12-31T23:59:59.999Z

updatedFromstringOptional

Filter transactions updated after this date (ISO 8601)

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

updatedTostringOptional

Filter transactions updated before this date (ISO 8601)

Example: 2024-12-31T23:59:59.999Z

isClaimedone ofOptional

Filter by claimed status (true for claimed, false for unclaimed)

Example: false

booleanOptional

or

anyOptional

sortBystring · enumOptional

Field to sort by

Default: createdAtExample: idPossible values:

sortOrderstring · enumOptional

Sort order (ascending or descending)

Default: descExample: descPossible values:

pagenumberOptional

Page number (starts from 1)

Default: 1Example: 1

pageSizenumber · max: 100Optional

Number of items per page (max 100)

Default: 10Example: 10

Responses

200

Paginated list

application/json

totalnumberRequired

Total number of items across all pages

Example: 50

pagenumberRequired

Current page number (starts from 1)

Example: 1

pageSizenumberRequired

Number of items per page

Example: 10

401

Invalid or missing token

403

[ERR_403] You are not a member of this deployment

get

/api/v1/deployments/{deploymentId}/transactions

HTTPcURLJavaScriptPython

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

{
  "total": 50,
  "page": 1,
  "pageSize": 10,
  "items": [
    {
      "id": "1234567890123456789",
      "txHash": "0x5555666677778888999900001111222233334444555566667777888899990000",
      "currencyId": "1-0xdac17f958d2ee523a2206206994597c13d831ec7",
      "amount": "-5000.00",
      "status": "EXECUTED",
      "fromAddress": "0x1234567890123456789012345678901234567890",
      "toAddress": "0x9876543210987654321098765432109876543210",
      "operationId": "187654321987654321",
      "operationType": "invoice",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z",
      "blockNumber": 12345678,
      "blockchainFee": "0.001",
      "confirmations": 12,
      "chainId": "1",
      "canClaim": false,
      "isClaimed": false,
      "invoiceId": "1234567890123456789",
      "confirmedAt": "2024-01-01T00:00:00.000Z",
      "invoice": {
        "id": "1234567890123456789",
        "trackingId": "INV-2024-0001",
        "status": "Created"
      },
      "currency": {
        "id": "1-0xdac17f958d2ee523a2206206994597c13d831ec7",
        "symbol": "USDT",
        "name": "Tether USD",
        "chainId": "1",
        "address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
        "decimals": 18,
        "isScam": false,
        "isVerified": true
      }
    }
  ]
}

Get by ID

get

Get entity by ID

Authorizations

ApiKeyAuth

x-api-keystringRequired

Provide API key in X-API-Key header

Path parameters

deploymentIdstring · uuidRequired

Deployment unique identifier

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

transactionIdstringRequired

Transaction ID

Example: 1234567890123456789

Responses

200

Entity retrieved successfully

application/json

canClaimbooleanRequired

Can this invoice be claimed

Example: false

isClaimedbooleanRequired

Whether this transaction has been claimed

Example: false

401

Invalid or missing token

403

[ERR_403] You are not a member of this deployment

404

[ERR_404] Transaction not found

get

/api/v1/deployments/{deploymentId}/transactions/{transactionId}

HTTPcURLJavaScriptPython

GET /api/v1/deployments/{deploymentId}/transactions/{transactionId} HTTP/1.1
x-api-key: YOUR_API_KEY
Accept: */*

{
  "transaction": {
    "id": "1234567890123456789",
    "txHash": "0x5555666677778888999900001111222233334444555566667777888899990000",
    "currencyId": "1-0xdac17f958d2ee523a2206206994597c13d831ec7",
    "amount": "-5000.00",
    "status": "EXECUTED",
    "fromAddress": "0x1234567890123456789012345678901234567890",
    "toAddress": "0x9876543210987654321098765432109876543210",
    "operationId": "187654321987654321",
    "operationType": "invoice",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z",
    "blockNumber": 12345678,
    "blockchainFee": "0.001",
    "confirmations": 12,
    "chainId": "1",
    "canClaim": false,
    "isClaimed": false,
    "invoiceId": "1234567890123456789",
    "confirmedAt": "2024-01-01T00:00:00.000Z",
    "invoice": {
      "id": "1234567890123456789",
      "trackingId": "INV-2024-0001",
      "status": "Created"
    },
    "currency": {
      "id": "1-0xdac17f958d2ee523a2206206994597c13d831ec7",
      "symbol": "USDT",
      "name": "Tether USD",
      "chainId": "1",
      "address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
      "decimals": 18,
      "isScam": false,
      "isVerified": true
    }
  },
  "canClaim": false,
  "isClaimed": false,
  "invoice": {
    "id": "1234567890123456789",
    "trackingId": "INV-2024-0001",
    "status": "Created"
  },
  "currency": {
    "id": "1-0xdac17f958d2ee523a2206206994597c13d831ec7",
    "symbol": "USDT",
    "name": "Tether USD",
    "chainId": "1",
    "address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
    "decimals": 18,
    "isScam": false,
    "isVerified": true
  }
}