Validação de saque para cartão bancário

POST 
/api/withdrawal/validation/bank-card

Valida um saque para um cartão bancário externo, sem criar uma transação.

Requisição

application/json

Body

Corpo da requisiçãoobrigatório

Dados para validar um saque para cartão bancário.

srcWalletIdstringnullable
ID da carteira de origem.
Exemplo: W000000000001
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, 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
destCurrencystringobrigatório
Moeda de destino.
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
cardNumberstringobrigatório
Número do cartão.
Exemplo: 411111******1111
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

Exemplo

{
  "srcWalletId": "W000000000001",
  "amount": 10.25,
  "action": "GIVE",
  "note": "Sandbox transfer note",
  "srcCurrency": "USD",
  "destCurrency": "USD",
  "cardNumber": "411111******1111",
  "receiverInfo": {
    "status": "success"
  }
}

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