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

POST 
/api/withdrawal/internal-other

Cria uma transferência interna para outra conta da Volet.com e retorna a transação criada.

Requisição

application/json

Body

Corpo da requisiçãoobrigatório

Dados para criar 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

application/json

Esquema

Esquema

transactionIduuid
ID da transação.
Exemplo: 11111111-1111-4111-8111-111111111111
paymentMethodTypestring
Tipo de método de pagamento.
Valores possíveis: [INTERNAL_OTHERS]
Exemplo: INTERNAL_OTHERS
transactionTypestring
Tipo de transação.
Valores possíveis: [INTERNAL_TRANSFER_OTHER]
Exemplo: INTERNAL_TRANSFER_OTHER
statusstring
Status.
Valores possíveis: [PENDING, COMPLETED, CANCELED, REFUNDED]
Exemplo: COMPLETED
directionstring
Direção.
Valores possíveis: [DEPOSIT, WITHDRAWAL]
Exemplo: DEPOSIT
transactionDirectionstring
Direção da transação.
Valores possíveis: [INCOMING, OUTGOING, EXCHANGE]
Exemplo: OUTGOING
currencystring
Moeda.
Valores possíveis: [USD, EUR, USDT, USDC, BTC, ETH, SOL, TRX, XRP, TON, LTC]
Exemplo: USD
amountnumber
Valor.
Exemplo: 10.25
createdAtdate-time

Data de criação.

paymentScopestring
Escopo do pagamento.
Valores possíveis: [MERCHANT_API]
Exemplo: MERCHANT_API
orderIdstring
ID do pedido.
Exemplo: ORDER_123456
walletSrcIdstring
ID da carteira de origem.
Exemplo: USD880390848110
walletDestIdstring
ID da carteira de destino.
Exemplo: USD880390848110
fullCommissionnumber
Taxa total.
Exemplo: 10.25
commentstring
Comentário.
Exemplo: Sandbox transfer note
cryptoCurrencyTxHashstring
Hash da transação cripto.
Exemplo: 4e3ab7d90c8f254ad96e38d5471b72411d4cc47a6cd317a15ca020d8212b0f5e
completedAtdate-time

Data de conclusão.

Exemplo

{
  "transactionId": "11111111-1111-4111-8111-111111111111",
  "paymentMethodType": "INTERNAL_OTHERS",
  "transactionType": "INTERNAL_TRANSFER_OTHER",
  "status": "CREATED",
  "direction": "WITHDRAWAL",
  "transactionDirection": "OUTGOING",
  "currency": "USD",
  "amount": 10.25,
  "createdAt": "2026-01-15T10:30:00",
  "paymentScope": "MERCHANT_API",
  "orderId": "ORDER_123456",
  "walletSrcId": "USD880390848110",
  "walletDestId": "USD880390848110",
  "fullCommission": 10.25,
  "comment": "Sandbox transfer note",
  "cryptoCurrencyTxHash": "4e3ab7d90c8f254ad96e38d5471b72411d4cc47a6cd317a15ca020d8212b0f5e",
  "completedAt": "2026-01-15T10:30:00"
}

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": {}
      }
    ]
  }
}