---
updatedAt: 2026-04-22T12:43:22.000Z
agentTools:
  projectIndex: https://docs.frenet.com.br/llms.txt
---

# Serviço para criação de deposito

Adicionar saldo à Carteira Frenet do Cliente

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "Frenet Partner Wallet Integration API",
    "version": "2.1",
    "title": "Frenet Partner Wallet Integration API",
    "contact": {
      "name": "Suporte Técnico",
      "url": "https://ajuda.frenet.com.br/",
      "email": "suporte@frenet.com.br"
    }
  },
  "tags": [
    {
      "name": "Wallet",
      "description": "Serviços para Consulta as informações da carteira do Cliente Frenet, vinculada ao parceiro"
    }
  ],
  "paths": {
    "/wallet/deposit": {
      "post": {
        "tags": [
          "Wallet"
        ],
        "summary": "Serviço para criação de deposito",
        "description": "Adicionar saldo à Carteira Frenet do Cliente",
        "operationId": "createDepositAsync",
        "parameters": [
          {
            "in": "header",
            "name": "token",
            "required": true,
            "description": "Token do Cliente",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "name": "x-partner-token",
            "required": true,
            "description": "Token do parceiro",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Deposit"
              }
            }
          },
          "description": "Dados do envio",
          "required": true
        },
        "responses": {
          "200": {
            "description": "successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DepositResponse"
                }
              }
            }
          },
          "400": {
            "description": "business error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "401": {
            "description": "unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "internal error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security": [
          {
            "api_key": []
          },
          {
            "api_partner_key": []
          }
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://whitelabel.frenet.com.br/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "api_key": {
        "type": "apiKey",
        "name": "token",
        "in": "header"
      },
      "api_partner_key": {
        "description": "API para identificação do partner",
        "type": "apiKey",
        "name": "x-partner-token",
        "in": "header"
      }
    },
    "schemas": {
      "Error": {
        "type": "object",
        "properties": {
          "Message": {
            "type": "string",
            "description": "Mensagem de retorno"
          },
          "Details": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ErrorDetail"
            },
            "description": "Lista de erros, quando houver"
          }
        },
        "example": {
          "Message": "Mensagem de Erro",
          "Details": [
            {
              "Code": 401,
              "Message": "Não Autorizado"
            },
            {
              "Code": 1000,
              "Message": "Cotação inválida (SessionId)"
            },
            {
              "Code": 2001,
              "Message": "Nome do remetente inválido"
            },
            {
              "Code": 2002,
              "Message": "Email do remetente inválido"
            }
          ]
        }
      },
      "ErrorDetail": {
        "type": "object",
        "description": "## Lista dos possíveis erros retornados pela API\n  | Code | Message |\n  | --- | ------- | \n  | 401 | Não Autorizado - Token Inválido |\n  | 403 | Sem permissão para acessar o recurso |\n  | 500 | Detalhes da exceção |\n  | 1000 | Cotação inválida (SessionId) |\n  | 1001 | Cep de origem inválido |\n  | 1002 | Cep de destino inválido |\n  | 1003 | Peso do pacote inválido |\n  | 1999 | Não foi possível obter cotação. Detalhes {0} |\n  | 2001 | Nome do remetente inválido |\n  | 2002 | Email do remetente inválido |\n  | 2003 | Rua do remetente inválida |\n  | 2004 | Numero do remetente inválido |\n  | 2005 | Bairro do remetente inválido |\n  | 2006 | Cidade do remetente inválida |\n  | 2007 | Estado do remetente inválido |\n  | 2008 | Nome do destinatário inválido |\n  | 2009 | CPF/CNPJ do destinatário inválido |\n  | 2010 | Telefone do destinatário inválido |\n  | 2011 | Rua do destinatário inválida |\n  | 2012 | Numero do destinatário inválido |\n  | 2013 | Bairro do destinatário inválido |\n  | 2014 | Cidade do destinatário inválida |\n  | 2015 | Estado do destinatário inválido |\n  | 2016 | Peso do volume inválido |\n  | 2017 | Valor de frete do volume inválido |\n  | 2018 | Identificação do volume inválida |\n  | 2019 | Agência de postagem inválida |\n  | 2020 | Chave da nota fiscal inválida |\n  | 2021 | O CNPJ emissor da chave de acesso é diferente do CNPJ de cadastro |\n  | 2999 | Não foi possível inserir o envio. Detalhes {0} |\n  | 3000 | Saldo insuficiente. |\n  | 3999 | Não foi possível pagar o envio. Detalhes {0} |\n  | 4000 | Problema de comunicação com a transportadora. Detalhes {0} |\n  | 4999 | Não foi possível gerar a etiqueta do envio. Detalhes {0} |\n  ---\n",
        "properties": {
          "Code": {
            "type": "integer",
            "format": "int32",
            "description": "Código do erro"
          },
          "Message": {
            "type": "string",
            "description": "Mensagem de retorno"
          }
        },
        "example": {
          "Code": 2011,
          "Message": "Rua do destinatário inválida"
        }
      },
      "Deposit": {
        "allOf": [
          {
            "type": "object",
            "required": [
              "Value",
              "NotificationUrl",
              "CallbackUrls"
            ],
            "properties": {
              "Value": {
                "type": "number",
                "format": "double",
                "description": "Valor do deposito"
              },
              "NotificationUrl": {
                "type": "string",
                "description": "URL para receber notificação do status do depósito."
              },
              "CallbackUrls": {
                "$ref": "#/components/schemas/DepositCallBack"
              }
            }
          }
        ]
      },
      "DepositCallBack": {
        "allOf": [
          {
            "type": "object",
            "required": [
              "SuccessUrl",
              "FailureUrl",
              "PendingUrl"
            ],
            "properties": {
              "SuccessUrl": {
                "type": "string",
                "description": "URL que será chamada pelo meio de pagamento em caso de sucesso no pagamento."
              },
              "FailureUrl": {
                "type": "string",
                "description": "URL que será chamada pelo meio de pagamento em caso de erro no pagamento."
              },
              "PendingUrl": {
                "type": "string",
                "description": "URL que será chamada pelo meio de pagamento para pagamento pendente."
              }
            }
          }
        ]
      },
      "DepositResponse": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "PreferenceId": {
                "type": "string",
                "description": "Chave do deposito que deve ser usada no checkout do gateway"
              },
              "DepositReference": {
                "type": "string",
                "description": "Identificador do depósito na Frenet"
              }
            }
          }
        ]
      }
    }
  },
  "x-readme": {}
}
```