Criação de saque para endereço cripto externo

POST /api/withdrawal/crypto-external

Cria um saque para um endereço cripto externo com conversão de moeda e retorna a transação criada.

Requisição

application/json

Body
Exemplo

Corpo da requisiçãoobrigatório

Dados para criar um saque para um endereço cripto externo.

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

destCurrencystringobrigatório

Moeda de destino.

Valores possíveis: [BTC, ETH, SOL, TRX, XRP, TON, LTC, AVAX, BNB, POL, USDT, USDT_BEP20, USDT_ERC20, USDT_TRC20, USDT_SOL, USDT_AVAXC, USDT_POL, USDT_OP, USDT_ARB, USDT_TON, USDC, USDC_ERC20, USDC_BEP20, USDC_ARB, USDC_OP, USDC_POL, USDC_AVAXC, USDC_SOL]

Exemplo: USD

address objectobrigatório

Esquema Merchant Crypto Address.

addressstringobrigatório

Endereço.

Exemplo: test-value

memostringnullable

Memo.

Exemplo: test-value

receiverInfo object

Esquema Merchant Receiver Info.

firstNamestring

Nome.

Valores possíveis: <= 30 caracteres

Exemplo: Leo

lastNamestring

Sobrenome.

Valores possíveis: <= 30 caracteres

Exemplo: Peo

emailstring

E-mail.

Valores possíveis: <= 50 caracteres

Exemplo: [email protected]

dateOfBirthstring

Data de nascimento.

Exemplo: 30/01/1991

companyNamestring

Nome da empresa.

Valores possíveis: >= 3 caracteres and <= 100 caracteres

Exemplo: PotterCompany

srcCurrencystringnullable

Moeda de origem.

Valores possíveis: [USD, EUR, USDT, USDC, BTC, ETH, SOL, TRX, XRP, TON, LTC]

Exemplo: USD

{
  "srcWalletId": "USD880390848110",
  "amount": 10.25,
  "action": "GIVE",
  "note": "Sandbox transfer note",
  "destCurrency": "BTC",
  "address": {
    "address": "TLxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "memo": null
  },
  "receiverInfo": {
    "firstName": "Leo",
    "lastName": "Peo",
    "email": "[email protected]"
  },
  "srcCurrency": "USD"
}

Respostas

application/json

Esquema
Exemplo

Esquema

transactionIduuid

ID da transação.

Exemplo: 11111111-1111-4111-8111-111111111111

paymentMethodTypestring

Tipo de método de pagamento.

Valores possíveis: [INTERNAL_OWN, INTERNAL_OTHERS, INTERNAL_SCI, CRYPTOWALLET, CRYPTO_EXTERNAL, BALANCE_ADJUSTMENT, CURRENCY_EXCHANGE_ADJUSTMENT, SYSTEM_PAYMENT, BANK_CARD_TEST_PAYMENT, SYSTEM_BONUS, USER_SUBSCRIPTION, BANK_CARD, BANK_CARD_LIMITED, BANK_CARD_EXTENDED, APPLE_PAY_CRYPTO, GOOGLE_PAY_CRYPTO, VISA, VISA_EXTENDED, VISA_LIMITED, MASTERCARD, MASTERCARD_EXTENDED, MASTERCARD_LIMITED, AMERICAN_EXPRESS, DINERS_CLUB, DISCOVER, INSTAPAYMENT, JCB, LASER, MAESTRO, MIR, YANDEX_MONEY, SWIFT, SEPA, SWIFT_EUR, LOCAL_BANK_TRANSFER, EPS_LOCAL_BANK_TRANSFER, EPS_SWIFT, EPS_CIPS, EPS_FPS, EPS_BANK_CARD_RU, CRYPTO_COLLECTION, CARD_PROGRAM_ISSUE_PAYMENT, CARD_PROGRAM_DELIVERY_PAYMENT, CARD_PROGRAM_VIEW_PIN_PAYMENT, CARD_PROGRAM_MONTHLY_FEE, CARD_PROGRAM_YEARLY_FEE, CARD_PROGRAM_REACTIVATION_FEE, CARD_PROGRAM, GLOBAL_PLUS, EUROPE_VISA_PLASTIC, EUROPE_VISA_VIRTUAL, EUROPE_MC_PLASTIC, EUROPE_MC_VIRTUAL, APAC_MC_PLASTIC, DIGITAL]

Exemplo: INTERNAL_OWN

transactionTypestring

Tipo de transação.

Valores possíveis: [DEPOSIT, INTERNAL_TRANSFER_OTHER, INTERNAL_TRANSFER_OWN, SMS_DELIVERY_PAYMENT, ADDITIONAL_COMMISSION, SYSTEM_PAYMENT, WITHDRAWAL, REFUND]

Exemplo: DEPOSIT

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, GBP, RUB, UAH, KZT, BRL, TRY, AZN, ARS, AUD, BDT, CAD, CLP, COP, DOP, EGP, HKD, INR, IDR, JPY, MYR, MXN, MAD, NPR, NZD, PKR, PEN, PHP, SGD, ZAR, KRW, LKR, THB, AED, VND, CNY, CNH, BTC, BNB, BNB_BEP20, BNB_BEP2, BNB_ERC20, BCH, DAI, DOGE, DOGE_DOGENT, DOGE_BEP2, DOGE_BEP20, ETH, LTC, USDP, XRP, SHIB, SHIB_BEP20, SHIB_ERC20, USDT, USDT_BEP20, USDT_ERC20, USDT_TRC20, USDT_SOL, USDT_AVAXC, USDT_POL, USDT_OP, USDT_ARB, TRX, TUSD, USDC, USDC_ERC20, USDC_BEP20, USDC_BEP2, ZEC, BUSD, BUSD_BEP20, BUSD_ERC20, BUSD_TRC20, TON, SOL, ADA, AVAX, DOT, LINK, NEAR, POL, DASH, USDT_TON, USDC_ARB, USDC_OP, USDC_POL, USDC_AVAXC, USDC_SOL]

Exemplo: USD

amountnumber

Valor.

Exemplo: 10.25

createdAtdate-time

Data de criação.

paymentScopestring

Escopo do pagamento.

Valores possíveis: [PERSONAL, BUSINESS, MERCHANT_API, PAYMENT_GATEWAY]

Exemplo: PERSONAL

orderIdstring

ID do pedido.

Exemplo: ORDER_123456

walletSrcIdstring

ID da carteira de origem.

Exemplo: W000000000001

walletDestIdstring

ID da carteira de destino.

Exemplo: W000000000001

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.

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

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

application/json

Esquema
Exemplo

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.

]

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

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

application/json

Esquema
Exemplo

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.

]

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

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

application/json

Esquema
Exemplo

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.

]

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

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

application/json

Esquema
Exemplo

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.

]

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

Criação de saque para endereço cripto externo

/api/withdrawal/crypto-external

Requisição​

Corpo da requisiçãoobrigatório

Respostas​

Requisição

Respostas