---
title: /customers/{document}/wallet
slug: customersdocumentwallet
createdAt: 2023-07-20T14:59:31.346Z
---

{
  "id": "6YzCoyqqJryo5LrL_xBz4",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "/customers/{document}/wallet",
    "name": "/customers/{document}/wallet",
    "description": "Retorna carteira de cashback do cliente.",
    "contentType": "application/json",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "document",
          "type": "string",
          "description": "Documento do cliente"
        }
      ],
      "headerParameters": [],
      "queryParameters": [],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "Carteira retornada com sucesso",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "customType": "CustomerProfileWalletResultDto",
            "schema": [
              {
                "name": "id",
                "kind": "required",
                "type": "number",
                "description": "Identificador da carteira"
              },
              {
                "name": "user_id",
                "kind": "required",
                "type": "number",
                "description": "Identificador do usuário"
              },
              {
                "name": "balance",
                "kind": "required",
                "type": "number",
                "description": "Valor de cashback disponível para resgate"
              },
              {
                "name": "pending_balance",
                "kind": "required",
                "type": "number",
                "description": "Valor de cashback pendente"
              },
              {
                "name": "created_at",
                "kind": "required",
                "type": "string<date-time>",
                "description": "Data de criação da carteira"
              },
              {
                "name": "updated_at",
                "kind": "required",
                "type": "string<date-time>",
                "description": "Data da última atualização"
              }
            ],
            "modelRef": "#/components/schemas/CustomerProfileWalletResultDto",
            "isExpanded": true
          }
        ]
      }
    ],
    "examples": {
      "languages": [
        {
          "id": "example-0-curl",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url /customers/{document}/wallet \\\n     --header 'accept: application/json'"
        },
        {
          "id": "example-1-javascript",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"/customers/{document}/wallet\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "example-2-ruby",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"/customers/{document}/wallet\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = http.request(request)\nputs response.read_body\n"
        },
        {
          "id": "example-3-python",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"/customers/{document}/wallet\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "example-0-curl"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-200",
          "language": "200",
          "code": "// Carteira retornada com sucesso\n{\n  \"id\": 0,\n  \"user_id\": 0,\n  \"balance\": 0,\n  \"pending_balance\": 0,\n  \"created_at\": \"\",\n  \"updated_at\": \"\"\n}"
        }
      ],
      "selectedLanguageId": "response-0-200"
    }
  },
  "children": [
    {
      "id": "7w5AVPO3KYNKU3aZfnbdQ",
      "type": "paragraph",
      "children": [
        {
          "text": "Retorna carteira de cashback do cliente."
        }
      ]
    }
  ]
}