Validação de transferência interna para outra conta

POST 
/api/withdrawal/validation/internal-other

Valida uma transferência interna para outra conta da Volet.com, sem criar uma transação.

Requisição

application/json

Body

Corpo da requisiçãoobrigatório

Dados para validar uma transferência interna para outra conta.

srcWalletIdstringnullable
ID da carteira de origem.
Exemplo: USD880390848110
amountnumberobrigatório
Valor.
Valores possíveis: >= 0
Exemplo: 10.25
actionstringobrigatório
Ação.
Valores possíveis: [GIVE, GET]
Exemplo: GIVE
notestringnullable
Observação.
Valores possíveis: <= 255 caracteres
Exemplo: Sandbox transfer note
srcCurrencystringnullable
Moeda de origem.
Valores possíveis: [USD, EUR, USDT, USDC, BTC, ETH, SOL, TRX, XRP, TON, LTC]
Exemplo: USD
destWalletIdstringnullable
ID da carteira de destino.
Exemplo: USD880390848110
destCurrencystringnullable
Moeda de destino.
Valores possíveis: [USD, EUR, USDT, USDC, BTC, ETH, SOL, TRX, XRP, TON, LTC]
Exemplo: USD
destEmailstringnullable
E-mail do destinatário.
Exemplo: [email protected]

Exemplo

{
  "srcWalletId": "USD880390848110",
  "amount": 10.25,
  "action": "GIVE",
  "note": "Sandbox transfer note",
  "srcCurrency": "USD",
  "destWalletId": "USD880390848110",
  "destCurrency": "USD",
  "destEmail": "[email protected]"
}

Respostas

200

OK

400

Requisição inválida. A requisição está malformada ou contém parâmetros inválidos.

application/json

Esquema

Esquema

statusstringobrigatório
Status da resposta.
Valores possíveis: [error]
Exemplo: error
data objectobrigatório
Dados da resposta de erro.
errors object[]obrigatório
Lista de erros retornados para a requisição.
Array [
errorMessagestringobrigatório
Código de erro estável e legível por máquina.
Exemplo: disabled
errorTypestringobrigatório
Categoria do erro.
Exemplo: FORM
errorIdstringobrigatório
Identificador curto e único do erro para suporte e logs.
Exemplo: errTest1234
errorDescriptionstringobrigatório
Descrição legível do erro.
Exemplo: REQUESTED OPERATION IS DISABLED FOR THE MERCHANT API
errorFieldstringnullable
Campo da requisição relacionado ao erro, se houver.
Exemplo: null
paramsobject[]obrigatório
Parâmetros adicionais do erro.
requestParamsobjectobrigatório
Parâmetros da requisição registrados para diagnóstico.
]

Exemplo

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "disabled",
        "errorType": "FORM",
        "errorId": "errTest1234",
        "errorDescription": "REQUESTED OPERATION IS DISABLED FOR THE MERCHANT API",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

401

Não autorizado. Os cabeçalhos de autenticação do lojista estão ausentes ou inválidos.

application/json

Esquema

Esquema

statusstringobrigatório
Status da resposta.
Valores possíveis: [error]
Exemplo: error
data objectobrigatório
Dados da resposta de erro.
errors object[]obrigatório
Lista de erros retornados para a requisição.
Array [
errorMessagestringobrigatório
Código de erro estável e legível por máquina.
Exemplo: userDoesNotExistException
errorTypestringobrigatório
Categoria do erro.
Exemplo: GENERAL
errorIdstringobrigatório
Identificador curto e único do erro para suporte e logs.
Exemplo: errTest1234
errorDescriptionstringobrigatório
Descrição legível do erro.
Exemplo: NOT FOUND API WITH ACCOUNT_EMAIL: [email protected]
errorFieldstringnullable
Campo da requisição relacionado ao erro, se houver.
Exemplo: null
paramsobject[]obrigatório
Parâmetros adicionais do erro.
requestParamsobjectobrigatório
Parâmetros da requisição registrados para diagnóstico.
]

Exemplo

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "userDoesNotExistException",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "NOT FOUND API WITH ACCOUNT_EMAIL: [email protected]",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

404

Não encontrado. O recurso solicitado não existe.

application/json

Esquema

Esquema

statusstringobrigatório
Status da resposta.
Valores possíveis: [error]
Exemplo: error
data objectobrigatório
Dados da resposta de erro.
errors object[]obrigatório
Lista de erros retornados para a requisição.
Array [
errorMessagestringobrigatório
Código de erro estável e legível por máquina.
Exemplo: resourceNotFound
errorTypestringobrigatório
Categoria do erro.
Exemplo: GENERAL
errorIdstringobrigatório
Identificador curto e único do erro para suporte e logs.
Exemplo: errTest1234
errorDescriptionstringobrigatório
Descrição legível do erro.
Exemplo: Resource not found
errorFieldstringnullable
Campo da requisição relacionado ao erro, se houver.
Exemplo: null
paramsobject[]obrigatório
Parâmetros adicionais do erro.
requestParamsobjectobrigatório
Parâmetros da requisição registrados para diagnóstico.
]

Exemplo

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "resourceNotFound",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "Resource not found",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}

500

Erro interno do servidor. Erro inesperado, entre em contato com o suporte

application/json

Esquema

Esquema

statusstringobrigatório
Status da resposta.
Valores possíveis: [error]
Exemplo: error
data objectobrigatório
Dados da resposta de erro.
errors object[]obrigatório
Lista de erros retornados para a requisição.
Array [
errorMessagestringobrigatório
Código de erro estável e legível por máquina.
Exemplo: internalServerError
errorTypestringobrigatório
Categoria do erro.
Exemplo: GENERAL
errorIdstringobrigatório
Identificador curto e único do erro para suporte e logs.
Exemplo: errTest1234
errorDescriptionstringobrigatório
Descrição legível do erro.
Exemplo: Internal server error
errorFieldstringnullable
Campo da requisição relacionado ao erro, se houver.
Exemplo: null
paramsobject[]obrigatório
Parâmetros adicionais do erro.
requestParamsobjectobrigatório
Parâmetros da requisição registrados para diagnóstico.
]

Exemplo

{
  "status": "error",
  "data": {
    "errors": [
      {
        "errorMessage": "internalServerError",
        "errorType": "GENERAL",
        "errorId": "errTest1234",
        "errorDescription": "Internal server error",
        "errorField": null,
        "params": [],
        "requestParams": {}
      }
    ]
  }
}