Consulta de limites mínimos

GET 
/api/account/limits/min

Retorna os limites mínimos de pagamento para o método de pagamento da API e o par de moedas selecionados.

Requisição

Parâmetros Query

apiPaymentMethod stringobrigatório
Valores possíveis: [INTERNAL_OWN, INTERNAL_OTHERS, CRYPTOWALLET, CRYPTO_INVOICE, CRYPTO_EXTERNAL]
Método de pagamento da API.
Exemplo: INTERNAL_OWN
currency string
Valores possíveis: [USD, EUR, GBP, TRY, VND, 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, CNY, CNH, BTC, BNB, ETH, LTC, XRP, USDT, USDT_BEP20, USDT_ERC20, USDT_TRC20, USDT_SOL, USDT_AVAXC, USDT_POL, USDT_OP, USDT_ARB, TRX, USDC, USDC_ERC20, USDC_BEP20, TON, SOL, AVAX, POL, USDT_TON, USDC_ARB, USDC_OP, USDC_POL, USDC_AVAXC, USDC_SOL]
Filtro por moeda de origem.
Exemplo: USD
currencyConverted string
Valores possíveis: [USD, EUR, GBP, TRY, VND, 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, CNY, CNH, BTC, BNB, ETH, LTC, XRP, USDT, USDT_BEP20, USDT_ERC20, USDT_TRC20, USDT_SOL, USDT_AVAXC, USDT_POL, USDT_OP, USDT_ARB, TRX, USDC, USDC_ERC20, USDC_BEP20, TON, SOL, AVAX, POL, USDT_TON, USDC_ARB, USDC_OP, USDC_POL, USDC_AVAXC, USDC_SOL]
Filtro por moeda de destino.
Exemplo: USD

Respostas

200

OK

application/json

Esquema

Esquema

• Array [
limitTypestring
Tipo de limite.
Valores possíveis: [SINGLE_PAYMENT_LOW, SINGLE_PAYMENT_SENDER_LOW]
Exemplo: SINGLE_PAYMENT_LOW
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
valuenumber
Valor.
Exemplo: 1.25
valueConverted object
Valor convertido.
property name*number
• ]

Exemplo

[
  {
    "limitType": "SINGLE_PAYMENT_LOW",
    "currency": "USD",
    "value": 1.25,
    "valueConverted": {}
  }
]

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