get_wallet_onboarding

How to get your agent a wallet with PayBox, the default non-custodial wallet: the four steps, and PayBox's MCP, CLI and TypeScript SDK with what to copy, in English or in Spanish. The same guide as emporium_wallet_onboarding

GET https://emporium.ultravioletadao.xyz/api/wallet/onboarding

Where to reach it

REST APIRead-onlyGET https://emporium.ultravioletadao.xyz/api/wallet/onboarding
MCPRead-onlyemporium_wallet_onboarding POST https://emporium.ultravioletadao.xyz/mcp
emporium_wallet_onboarding POST https://emporium.ultravioletadao.xyz/counter/mcp
CLIRead-onlyuvd call emporium_wallet_onboarding
Python SDKComing soon
TypeScript SDKComing soon
Rust SDKComing soon

Live: you can use it today, to read and to write. Read-only: today you can read, not write. Coming soon: not there yet.

Parameters

NameInRequiredSchemaWhat it is
idiomaqueryno{"$ref":"#/components/schemas/IdiomaDeLaConsulta"}

Request body

It takes no body.

Responses

200

OK

application/json

{
  "$ref": "#/components/schemas/WalletOnboarding"
}

Any other status

An error: with JSON, the single envelope, whose error.codigo is one of a closed list

application/json

{
  "$ref": "#/components/schemas/SobreDeError"
}

Schemas

The ones this operation names, as they are in the contract's components.schemas.

CodigoDeError
{
  "enum": [
    "dominio_invalido",
    "slug_ocupado",
    "tenant_no_encontrado",
    "tenant_no_publicado",
    "tenant_suspendido",
    "clave_invalida",
    "estado_no_permite",
    "ventana_no_cumplida",
    "metodo_invalido",
    "manifiesto_invalido",
    "categoria_prohibida",
    "terminos_no_aceptados",
    "canal_no_confirmado",
    "version_de_terminos_desconocida",
    "pedido_invalido",
    "faltan_datos",
    "respuesta_invalida",
    "firma_invalida",
    "enlace_vencido",
    "enlace_ya_usado",
    "demasiadas_peticiones",
    "parametro_invalido",
    "metodo_no_permitido",
    "firma_no_configurada",
    "correo_no_configurado",
    "terminos_no_configurados",
    "casa_no_configurada",
    "almacen_no_disponible",
    "error_interno",
    "paybox_no_configurado",
    "boveda_no_disponible",
    "sesion_requerida",
    "estado_oauth_invalido",
    "consentimiento_rechazado",
    "concesion_insegura",
    "paybox_no_responde",
    "paybox_rechazo",
    "sin_vinculo",
    "vinculo_revocado",
    "vinculo_vencido",
    "reconexion_requerida",
    "vinculo_ajeno",
    "renovacion_en_curso"
  ],
  "type": "string"
}
CuerpoDelError
{
  "additionalProperties": false,
  "properties": {
    "codigo": {
      "$ref": "#/components/schemas/CodigoDeError"
    },
    "detalles": {
      "items": {
        "$ref": "#/components/schemas/Detalle"
      },
      "type": "array"
    },
    "mensaje": {
      "type": "string"
    },
    "peticion_id": {
      "type": "string"
    }
  },
  "required": [
    "codigo",
    "detalles",
    "mensaje",
    "peticion_id"
  ],
  "type": "object"
}
Detalle
{
  "additionalProperties": false,
  "properties": {
    "campo": {
      "type": "string"
    },
    "problema": {
      "type": "string"
    }
  },
  "required": [
    "campo",
    "problema"
  ],
  "type": "object"
}
EnlacesDePaybox
{
  "properties": {
    "app": {
      "type": "string"
    },
    "docs": {
      "type": "string"
    },
    "mcp": {
      "type": "string"
    },
    "npm_package": {
      "type": "string"
    },
    "site": {
      "type": "string"
    }
  },
  "required": [
    "app",
    "docs",
    "mcp",
    "npm_package",
    "site"
  ],
  "type": "object"
}
IdiomaDeLaConsulta
{
  "enum": [
    "es",
    "en"
  ],
  "type": "string"
}
PasoDelOnboarding
{
  "properties": {
    "id": {
      "type": "string"
    },
    "step": {
      "format": "uint8",
      "maximum": 255,
      "minimum": 0,
      "type": "integer"
    },
    "text": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "url": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "id",
    "step",
    "text",
    "title"
  ],
  "type": "object"
}
PuertaDePaybox
{
  "oneOf": [
    {
      "const": "mcp",
      "type": "string"
    },
    {
      "const": "cli",
      "type": "string"
    },
    {
      "const": "sdk_typescript",
      "type": "string"
    }
  ]
}
PuertaDelOnboarding
{
  "properties": {
    "code": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "docs": {
      "type": "string"
    },
    "id": {
      "$ref": "#/components/schemas/PuertaDePaybox"
    },
    "name": {
      "type": "string"
    },
    "text": {
      "type": "string"
    }
  },
  "required": [
    "code",
    "docs",
    "id",
    "name",
    "text"
  ],
  "type": "object"
}
SobreDeError
{
  "additionalProperties": false,
  "properties": {
    "error": {
      "$ref": "#/components/schemas/CuerpoDelError"
    }
  },
  "required": [
    "error"
  ],
  "type": "object"
}
WalletOnboarding
{
  "properties": {
    "custody": {
      "type": "string"
    },
    "doors": {
      "items": {
        "$ref": "#/components/schemas/PuertaDelOnboarding"
      },
      "type": "array"
    },
    "emporium_holds_your_keys": {
      "type": "boolean"
    },
    "language": {
      "type": "string"
    },
    "links": {
      "$ref": "#/components/schemas/EnlacesDePaybox"
    },
    "read_on": {
      "type": "string"
    },
    "steps": {
      "items": {
        "$ref": "#/components/schemas/PasoDelOnboarding"
      },
      "type": "array"
    },
    "summary": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "wallet_provider": {
      "type": "string"
    }
  },
  "required": [
    "custody",
    "doors",
    "emporium_holds_your_keys",
    "language",
    "links",
    "read_on",
    "steps",
    "summary",
    "title",
    "wallet_provider"
  ],
  "type": "object"
}