Wallets

Fetches the list of available wallet providers to populate the dropdown box in the New Disbursement flow. The organization should coordinate with the wallet provider before selecting a particular wallet provider for a disbursement. By default, soft-deleted wallets are excluded from the response. Use the include_deleted parameter to include them.

get/wallets

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

include_deletedboolean

When set to true, includes soft-deleted wallets in the response. When false or omitted, only non-deleted wallets are returned.

enabledboolean

Filter wallets by enabled/disabled status.

user_managedboolean

Filter by user-managed wallets.

supported_assetsstring

Comma-separated list of asset codes or IDs to filter wallets by supported assets (max 20).

Response

A list of wallets

idstring
namestring
homepagestring
sep_10_client_domainstring
deep_link_schemastring
created_atstring date-time
updated_atstring date-time

Example response

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

Changes

    • info

      added the new optional query request parameter enabled

    • info

      added the new optional query request parameter include_deleted

    • info

      added the new optional query request parameter supported_assets

    • info

      added the new optional query request parameter user_managed

    • info

      added the non-success response with the status

    • info

      api tag Organization removed