Skip to main content

List wallet units

GET 
/v2/config/digital-wallet/openid/wallet-provider/wallet-units

Lists the wallet units that the wallet provider manages. Use the query parameters to filter by holder DID or by device platform, and to page through the results. The organisation must have the wallet provider capability enabled. The service replaces an offset that is less than 0 and a limit that is 0 or less with the default value. If offset is larger than the number of results, the service returns the last page.

Request​

Query Parameters

    holderDid string

    Filter by the holder's Decentralized Identifier (DID).

    platform stringrequired

    Filter by the device platform of the wallet unit. The known values are ios, android and organisation. The service does not check the value, so an unknown value matches no wallet unit.

    Example: ios
    offset integerrequired

    Default value: 0

    Number of records to skip for pagination. A negative or unreadable value falls back to 0.

    limit integerrequired

    Default value: 10

    Maximum number of records to return per page.

Header Parameters

    X-SandboxOrgId stringrequired

    Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.

    The service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org instead.

    X-SubwalletId is the deprecated name of this header. The service continues to accept it, but X-SandboxOrgId wins if you send both headers.

    The sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.

    Example: 6889e1a4c5b2f30001a3d710

Responses​

The wallet provider returned the wallet units.

Response Headers
    Schema
      walletUnit object[]required

      The wallet units on the current page. The list is empty if no wallet unit agrees with the filters.

      pagination objectrequired

      Page details for the result set.

      currentPage integer

      Current page number

      totalItems integer

      Total number of items available

      totalPages integer

      Total number of pages based on limit

      limit integer

      Number of items per page

      hasPrevious boolean

      Indicates if there's a previous page

      hasNext boolean

      Indicates if there's a next page

    Loading...
    Last updated on