STstellar
Wallets

Update Wallet

Changed on

This endpoint is used to enable or disable a wallet provider. Note: the organization should coordinate with the wallet provider before selecting a particular wallet provider for a disbursement.

patch/wallets/{id}

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

Path parameters

idstring required

ID of the wallet to update

Request body

namestring

Human-readable name of the wallet provider

homepagestring

Homepage URL of the wallet provider

deep_link_schemastring

Deep link schema for the wallet application

sep_10_client_domainstring

SEP-10 client domain for authentication

enabledboolean

Whether the wallet is enabled for use

Response

Wallet updated successfully

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

  • b6f8a6e65559Revision changes
    • breaking

      removed the media type */* for the response with the status

    • breaking

      removed the media type */* for the response with the status

    • breaking

      removed the media type */* for the response with the status

    • info

      the endpoint scheme security BearerAuth was added to the API

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 90ed1c557168Revision changes
    • info

      api tag Organization removed

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became optional