Payouts

Methods for creating, listing, and managing payouts in B2BINPAY DeFi API

Create

post

Create new entity

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

Body

application/json

deploymentIdstring · uuidRequired

currencyIdstring · min: 1Required

amountstring · min: 1RequiredPattern: ^\d+(\.\d+)?$

toAddressone ofRequired

stringOptional

or

string · min: 1Optional

trackingIdstring · min: 1 · max: 128OptionalPattern: ^[A-Za-z0-9\-]+$

callbackUrlstring · uriOptional

nonceintegerOptional

Responses

201

Entity created successfully

application/json

400

Invalid input

401

Invalid or missing token

404

[ERR_404] Deployment not found or [ERR_403] You are not a member of this deployment

post

/api/v1/deployments/{deploymentId}/payouts

HTTPcURLJavaScriptPython

POST /api/v1/deployments/{deploymentId}/payouts HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 176

{
  "deploymentId": "123e4567-e89b-12d3-a456-426614174000",
  "currencyId": "text",
  "amount": "text",
  "toAddress": "text",
  "trackingId": "text",
  "callbackUrl": "https://example.com",
  "nonce": 1
}

{
  "id": "1234567890123456789",
  "currencyId": "1-0xdac17f958d2ee523a2206206994597c13d831ec7",
  "amount": "100.50",
  "toAddress": "0x1234567890123456789012345678901234567890",
  "isTron": false,
  "deploymentId": "123e4567-e89b-12d3-a456-426614174000",
  "trackingId": "INV-2024-0001",
  "callbackUrl": "https://example.com/webhook/invoice",
  "queueOperationId": "187654321987654321",
  "nonce": "42",
  "status": "CREATED",
  "createdBy": "0x1234567890123456789012345678901234567890",
  "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
  }
}

Update

patch

Update entity

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

payoutIdstringRequired

Entity ID

Example: 1234567890123456789

Body

application/json

trackingIdstring · min: 1 · max: 128 · nullableRequiredPattern: ^[A-Za-z0-9\-]+$

callbackUrlstring · uri · nullableRequired

Responses

200

Entity retrieved successfully

application/json

idstringRequired

Entity unique identifier

Example: 1234567890123456789

currencyIdstringRequired

The unique ID of the currency, ("{chainId}-{contractAddress}")

Example: 1-0xdac17f958d2ee523a2206206994597c13d831ec7

amountstringRequired

Amount to be paid out

Example: 100.50

toAddressstringRequired

Wallet address (Ethereum 0x... or Tron TVM T...)

Example: 0x1234567890123456789012345678901234567890

isTronbooleanRequired

Whether the entity relates to Tron (TVM)

Example: false

deploymentIdstringRequired

Deployment unique identifier

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

trackingIdstringRequired

Tracking identifier

Example: INV-2024-0001

callbackUrlstringRequired

Callback URL for notifications

Example: https://example.com/webhook/invoice

queueOperationIdstring · nullableRequired

Queue operation ID associated with this payout

Example: 187654321987654321

noncestringRequired

Nonce for transaction ordering

Example: 42

statusstring · enumRequired

Current status of the payout

Example: CREATEDPossible values:

createdBystringRequired

Wallet address (Ethereum 0x... or Tron TVM T...)

Example: 0x1234567890123456789012345678901234567890

createdAtstringRequired

Creation timestamp

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

updatedAtstringRequired

Last update timestamp

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

400

Invalid input

401

Invalid or missing token

404

Payout not found or [ERR_403] You are not a member of this deployment

patch

/api/v1/deployments/{deploymentId}/payouts/{payoutId}

HTTPcURLJavaScriptPython

PATCH /api/v1/deployments/{deploymentId}/payouts/{payoutId} HTTP/1.1
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "trackingId": "text",
  "callbackUrl": "https://example.com"
}

{
  "id": "1234567890123456789",
  "currencyId": "1-0xdac17f958d2ee523a2206206994597c13d831ec7",
  "amount": "100.50",
  "toAddress": "0x1234567890123456789012345678901234567890",
  "isTron": false,
  "deploymentId": "123e4567-e89b-12d3-a456-426614174000",
  "trackingId": "INV-2024-0001",
  "callbackUrl": "https://example.com/webhook/invoice",
  "queueOperationId": "187654321987654321",
  "nonce": "42",
  "status": "CREATED",
  "createdBy": "0x1234567890123456789012345678901234567890",
  "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
  }
}

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 payout ID (text includes)

Example: 123e4567

createdFromstringOptional

Filter payouts created from this date (ISO string)

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

createdTostringOptional

Filter payouts created to this date (ISO string)

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

updatedFromstringOptional

Filter payouts updated from this date (ISO string)

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

updatedTostringOptional

Filter payouts updated to this date (ISO string)

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

currencyIdsstring[]Optional

Filter by currency IDs

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

trackingIdstringOptional

Filter by tracking ID (text includes)

Example: TRACK_123456

createdBystringOptional

Filter by creator (text includes)

Example: 0x742d35cc6635c0532925a3b8d0a7f79ec35bdc52

toAddressstringOptional

Filter by receiver address (text includes)

Example: 0x742d35cc6635c0532925a3b8d0a7f79ec35bdc52

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)

Example: 1

pageSizenumberOptional

Number of items per page (max 100)

Example: 10

Responses

200

Entity 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] Deployment not found or [ERR_403] You are not a member of this deployment

get

/api/v1/deployments/{deploymentId}/payouts

HTTPcURLJavaScriptPython

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

{
  "total": 1,
  "page": 1,
  "pageSize": 1,
  "items": [
    {
      "id": "1234567890123456789",
      "currencyId": "1-0xdac17f958d2ee523a2206206994597c13d831ec7",
      "amount": "100.50",
      "toAddress": "0x1234567890123456789012345678901234567890",
      "isTron": false,
      "deploymentId": "123e4567-e89b-12d3-a456-426614174000",
      "trackingId": "INV-2024-0001",
      "callbackUrl": "https://example.com/webhook/invoice",
      "queueOperationId": "187654321987654321",
      "nonce": "42",
      "status": "CREATED",
      "createdBy": "0x1234567890123456789012345678901234567890",
      "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
      }
    }
  ]
}

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

payoutIdstringRequired

Entity ID

Example: 1234567890123456789

Responses

200

Entity retrieved successfully

application/json

idstringRequired

Entity unique identifier

Example: 1234567890123456789

currencyIdstringRequired

The unique ID of the currency, ("{chainId}-{contractAddress}")

Example: 1-0xdac17f958d2ee523a2206206994597c13d831ec7

amountstringRequired

Amount to be paid out

Example: 100.50

toAddressstringRequired

Wallet address (Ethereum 0x... or Tron TVM T...)

Example: 0x1234567890123456789012345678901234567890

isTronbooleanRequired

Whether the entity relates to Tron (TVM)

Example: false

deploymentIdstringRequired

Deployment unique identifier

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

trackingIdstringRequired

Tracking identifier

Example: INV-2024-0001

callbackUrlstringRequired

Callback URL for notifications

Example: https://example.com/webhook/invoice

queueOperationIdstring · nullableRequired

Queue operation ID associated with this payout

Example: 187654321987654321

noncestringRequired

Nonce for transaction ordering

Example: 42

statusstring · enumRequired

Current status of the payout

Example: CREATEDPossible values:

createdBystringRequired

Wallet address (Ethereum 0x... or Tron TVM T...)

Example: 0x1234567890123456789012345678901234567890

createdAtstringRequired

Creation timestamp

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

updatedAtstringRequired

Last update timestamp

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

401

Invalid or missing token

404

Payout not found or [ERR_403] You are not a member of this deployment

get

/api/v1/deployments/{deploymentId}/payouts/{payoutId}

HTTPcURLJavaScriptPython

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

{
  "id": "1234567890123456789",
  "currencyId": "1-0xdac17f958d2ee523a2206206994597c13d831ec7",
  "amount": "100.50",
  "toAddress": "0x1234567890123456789012345678901234567890",
  "isTron": false,
  "deploymentId": "123e4567-e89b-12d3-a456-426614174000",
  "trackingId": "INV-2024-0001",
  "callbackUrl": "https://example.com/webhook/invoice",
  "queueOperationId": "187654321987654321",
  "nonce": "42",
  "status": "CREATED",
  "createdBy": "0x1234567890123456789012345678901234567890",
  "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
  }
}