Sign in
fund-distribution

List fund distribution requests. (admin access required)

Lists fund distribution requests, newest first. A request moves Pending -> Submitted -> Confirmed, or to Failed if it could not be sent or never landed on chain. Requests sharing a batchId went out in one transaction. Pagination is cursor-inclusive: the cursor row is returned again, so clients should dedupe by id.

get/fund-distribution

Request

  • Base URL: ./../api/v1/ (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ./../api/v1/fund-distribution
  • Auth: API key in header token

Query parameters

paymentSourceIdstring

Filter by payment source

fundWalletIdstring

Filter by fund wallet

status'Pending' | 'Submitted' | 'Confirmed' | 'Failed'

Filter by status

takeinteger

Number of results (max 100, default 20)

cursorIdstring

Cursor id for pagination

Response

Fund distribution requests

status'success' required

Example response

{
  "status": "success",
  "data": {
    "FundDistributions": [
      {
        "id": "cuid_v2_auto_generated",
        "createdAt": "2024-01-01T00:00:00.000Z",
        "updatedAt": "2024-01-01T00:00:00.000Z",
        "fundWalletId": "cuid_v2_auto_generated",
        "targetWalletId": "cuid_v2_auto_generated",
        "priority": "Warning",
        "assetUnit": "lovelace",
        "amount": "100000000",
        "status": "Confirmed",
        "txHash": "a1b2c3d4e5f6...",
        "error": null,
        "batchId": "cuid_v2_auto_generated"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 50 revisions of this API.