Retrieve Disbursement Statistics

Fetches metrics on a specific disbursement by id.

Path Parameters

• id string required

  ID of the Disbursement.

Responses

• 200
• 401
• 403

---

Returns statistics for disbursement

application/json

• Schema
• Example (from 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

{
  "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
}

Unauthorized

Response Headers

application/json

• Schema
• Example (from schema)
• response

---

Schema

• error string
• extras object

  status number

  message string

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

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

Forbidden

Response Headers

application/json

• Schema
• Example (from schema)
• response

---

Schema

• error string

{
  "error": "Forbidden"
}

{
  "error": "Forbidden"
}

Loading...