Claims

Methods for listing and executing invoice claims and batch collections in B2BINPAY DeFi API

Get claimable assets

get

Returns only uncollected deposits (EXECUTED status with isClaimed=false) grouped by invoice+currency

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

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

currencyIdsone ofOptional

Filter by currency IDs

Example: ["1-0x0000000000000000000000000000000000000000","1-0x1111111111111111111111111111111111111111"]

string · min: 1Optional

or

string[]Optional

invoiceIdstringOptional

Filter by invoice ID

Example: 1234567890123456789

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 claimable groups

Example: 15

pagenumberRequired

Current page number

Example: 1

pageSizenumberRequired

Number of items per page

Example: 20

400

Invalid input

401

Invalid or missing token

404

[ERR_404] Deployment not found

get

/api/v1/deployments/{deploymentId}/claims

HTTPcURLJavaScriptPython

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

{
  "total": 15,
  "page": 1,
  "pageSize": 20,
  "items": [
    {
      "invoiceId": "1234567890123456789",
      "invoiceNonce": "abcd1234567890abcd1234567890abcd",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z",
      "currency": {
        "id": "1-0xdac17f958d2ee523a2206206994597c13d831ec7",
        "symbol": "USDT",
        "name": "Tether USD",
        "chainId": "1",
        "address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
        "decimals": 18,
        "isScam": false,
        "isVerified": true
      },
      "amount": "100.50",
      "transactions": 3
    }
  ]
}

Get currencies with claimable balances

get

Returns all currencies that have non-zero claimable balances for the deployment

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

Responses

201

List of currencies with claimable balances

application/json

400

Invalid input

401

Invalid or missing token

404

[ERR_404] Deployment not found

get

/api/v1/deployments/{deploymentId}/claims/currencies

HTTPcURLJavaScriptPython

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

[
  {
    "id": "1-0xdac17f958d2ee523a2206206994597c13d831ec7",
    "symbol": "USDT",
    "name": "Tether USD",
    "chainId": "1",
    "address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
    "decimals": 18,
    "isScam": false,
    "isVerified": true
  }
]