STstellar
Disbursements

List All Disbursements

Changed on

Fetches all disbursements the organization has created. This endpoint supports pagination. The response includes basic aggregations on payments within the disbursement.

get/disbursements

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header Authorization

Query parameters

pagenumber

The page requested.

page_limitnumber

Define how many results will be returned in the response.

qstring

A search term used to query through the disbursement names.

status'DRAFT' | 'READY' | 'STARTED' | 'PAUSED' | 'COMPLETED' | 'CANCELED'

Comma-separated list of disbursement statuses to filter by.

created_at_afterstring

Only return disbursements that are created after this date. Format: YYYY-MM-DD

created_at_beforestring

Only return disbursements that are created before this date. Format: YYYY-MM-DD

sort'name' | 'created_at'

Field used to sort disbursements

direction'asc' | 'desc'

Direction for sorting disbursements.

Headers

X-Wallet-Idstring

Optional. Narrows the results to a single distribution account. Omit it to cover every account you have access to.

Response

A list of Disbursement details

Example response

{
  "pagination": {
    "next": "?page=3&page_limit=2",
    "prev": "?page=1&page_limit=2",
    "pages": 8,
    "total": 16
  },
  "data": [
    {
      "id": "619da857-8725-4c58-933d-c120a458e0f5",
      "name": "Disbursement Name",
      "receiver_registration_message_template": "You have a payment waiting for you from {{.OrganizationName}}. Click {{.RegistrationLink}} to register.",
      "wallet": {
        "id": "5ada9ed5-455a-4782-a0ee-160767e0deb1",
        "name": "Vibrant Assist",
        "homepage": "https://vibrantapp.com",
        "sep_10_client_domain": "api-dev.vibrantapp.com",
        "deep_link_schema": "https://vibrantapp.com/sdp-dev",
        "created_at": "2023-07-31T20:50:45.648Z",
        "updated_at": "2023-07-31T20:50:45.648Z"
      },
      "asset": {
        "id": "ffaec4b3-46b0-4db4-a4c4-6c3508057705",
        "code": "USDC",
        "issuer": "GBBD47IF6LWK7P7MDEVSCWR7DPUWV3NY3DTQEVFL4NAT4AQH3ZLLFLA5",
        "created_at": "2023-02-03T10:45:51Z",
        "updated_at": "2023-02-03T10:45:51Z",
        "deleted_at": "2023-06-03T10:55:51Z"
      },
      "source_wallet_id": "4c379f5e-09b5-4472-a286-b84e249a1512",
      "status_history": [
        {
          "user_id": "3f351b9e-ed0f-40fa-a314-14757b42dab1",
          "timestamp": "2023-02-03T10:45:51Z"
        }
      ],
      "file_name": "disbursement-feb-03-2023.csv",
      "created_at": "2023-02-03T10:45:51Z",
      "updated_at": "2023-02-03T10:45:51Z",
      "total_payments": 10,
      "total_payments_sent": 8,
      "total_payments_failed": 1,
      "total_payments_remaining": 1,
      "amount_disbursed": "800.00",
      "total_amount": "1000.00",
      "average_amount": "100.00"
    }
  ]
}

Changes

  • 7588d8d2a3c7Revision changes
    • warning

      added the new CANCELED enum value to the // response property for the response status

    • warning

      added the new CANCELED enum value to the //// response property for the response status

    • info

      added the new optional header request parameter X-Wallet-Id

    • info

      added the new enum value CANCELED to the query request parameter status

    • info

      added the optional property // to the response with the status

  • b6f8a6e65559Revision changes
    • breaking

      for the query request parameter direction, default value was changed from asc to desc