Retrieve Disbursement Statistics

GET 
/statistics/disbursements/:id

Fetches metrics on a specific disbursement by id.

Request

Path Parameters

id stringrequired

ID of the Disbursement.

Responses

200

Returns statistics for disbursement

application/json

Schema

Schema

payment_counters object
draft int64
ready int64
pending int64
paused int64
success int64
failed int64
total int64
payment_amounts_by_asset object[]
Array [
asset_code string
payment_amounts object
draft string
ready string
pending string
paused string
success string
failed string
average string
total string
]
receiver_wallets_counters object
draft int64
ready int64
registered int64
flagged int64
total int64
total_receivers int64

Total number of receivers

Example (from schema)

{
  "payment_counters": {
    "draft": 1,
    "ready": 2,
    "pending": 3,
    "paused": 1,
    "success": 5,
    "failed": 1,
    "total": 14
  },
  "payment_amounts_by_asset": [
    {
      "asset_code": "USDC",
      "payment_amounts": {
        "draft": "100.00",
        "ready": "200.00",
        "pending": "300.00",
        "paused": "100.00",
        "success": "500.00",
        "failed": "100.00",
        "average": "100.00",
        "total": "1400.00"
      }
    }
  ],
  "receiver_wallets_counters": {
    "draft": 1,
    "ready": 1,
    "registered": 1,
    "flagged": 1,
    "total": 4
  },
  "total_receivers": 100
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

error string
extras object
status number
message string

Example (from schema)

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

response

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

403

Forbidden

Response Headers

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Forbidden"
}

response

{
  "error": "Forbidden"
}

Loading...