Validar retiro a tarjeta bancaria

POST 
/api/withdrawal/validation/bank-card

Valida un retiro a una tarjeta bancaria externa, sin crear una transacción.

Solicitud

application/json

Body

Cuerpo de la solicitudobligatorio

Datos para validar un retiro a tarjeta bancaria.

srcWalletIdstringnullable
ID de la billetera de origen.
Ejemplo: W000000000001
amountnumberobligatorio
Monto.
Valores posibles: >= 0
Ejemplo: 10.25
actionstringobligatorio
Acción.
Valores posibles: [GIVE, GET]
Ejemplo: GIVE
notestringnullable
Nota.
Valores posibles: <= 255 caracteres
Ejemplo: Sandbox transfer note
srcCurrencystringnullable
Moneda de origen.
Valores posibles: [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]
Ejemplo: USD
destCurrencystringobligatorio
Moneda de destino.
Valores posibles: [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]
Ejemplo: USD
cardNumberstringobligatorio
Número de tarjeta.
Ejemplo: 411111******1111
receiverInfo object
Esquema Merchant Receiver Info.
firstNamestring
Nombre.
Valores posibles: <= 30 caracteres
Ejemplo: Leo
lastNamestring
Apellido.
Valores posibles: <= 30 caracteres
Ejemplo: Peo
emailstring
Email.
Valores posibles: <= 50 caracteres
Ejemplo: [email protected]
dateOfBirthstring
Fecha de nacimiento.
Ejemplo: 30/01/1991
companyNamestring
Nombre de la empresa.
Valores posibles: >= 3 caracteres and <= 100 caracteres
Ejemplo: PotterCompany

Ejemplo

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

Respuestas

200

OK

400

Solicitud incorrecta. La solicitud tiene un formato incorrecto o contiene parámetros no válidos.

application/json

Esquema

Esquema

statusstringobligatorio
Estado de la respuesta.
Valores posibles: [error]
Ejemplo: error
data objectobligatorio
Datos de la respuesta de error.
errors object[]obligatorio
Lista de errores devueltos para la solicitud.
Array [
errorMessagestringobligatorio
Código de error estable y legible por máquina.
Ejemplo: disabled
errorTypestringobligatorio
Categoría del error.
Ejemplo: FORM
errorIdstringobligatorio
Identificador único y corto del error para soporte y registros.
Ejemplo: errTest1234
errorDescriptionstringobligatorio
Descripción legible del error.
Ejemplo: REQUESTED OPERATION IS DISABLED FOR THE MERCHANT API
errorFieldstringnullable
Campo de la solicitud relacionado con el error, si lo hay.
Ejemplo: null
paramsobject[]obligatorio
Parámetros adicionales del error.
requestParamsobjectobligatorio
Parámetros de la solicitud guardados para diagnóstico.
]

Ejemplo

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

401

No autorizado. Faltan los encabezados de autenticación del comercio o no son válidos.

application/json

Esquema

Esquema

statusstringobligatorio
Estado de la respuesta.
Valores posibles: [error]
Ejemplo: error
data objectobligatorio
Datos de la respuesta de error.
errors object[]obligatorio
Lista de errores devueltos para la solicitud.
Array [
errorMessagestringobligatorio
Código de error estable y legible por máquina.
Ejemplo: userDoesNotExistException
errorTypestringobligatorio
Categoría del error.
Ejemplo: GENERAL
errorIdstringobligatorio
Identificador único y corto del error para soporte y registros.
Ejemplo: errTest1234
errorDescriptionstringobligatorio
Descripción legible del error.
Ejemplo: NOT FOUND API WITH ACCOUNT_EMAIL: [email protected]
errorFieldstringnullable
Campo de la solicitud relacionado con el error, si lo hay.
Ejemplo: null
paramsobject[]obligatorio
Parámetros adicionales del error.
requestParamsobjectobligatorio
Parámetros de la solicitud guardados para diagnóstico.
]

Ejemplo

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

404

No encontrado. El recurso solicitado no existe.

application/json

Esquema

Esquema

statusstringobligatorio
Estado de la respuesta.
Valores posibles: [error]
Ejemplo: error
data objectobligatorio
Datos de la respuesta de error.
errors object[]obligatorio
Lista de errores devueltos para la solicitud.
Array [
errorMessagestringobligatorio
Código de error estable y legible por máquina.
Ejemplo: resourceNotFound
errorTypestringobligatorio
Categoría del error.
Ejemplo: GENERAL
errorIdstringobligatorio
Identificador único y corto del error para soporte y registros.
Ejemplo: errTest1234
errorDescriptionstringobligatorio
Descripción legible del error.
Ejemplo: Resource not found
errorFieldstringnullable
Campo de la solicitud relacionado con el error, si lo hay.
Ejemplo: null
paramsobject[]obligatorio
Parámetros adicionales del error.
requestParamsobjectobligatorio
Parámetros de la solicitud guardados para diagnóstico.
]

Ejemplo

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

500

Error interno del servidor. Error inesperado, contacta al soporte

application/json

Esquema

Esquema

statusstringobligatorio
Estado de la respuesta.
Valores posibles: [error]
Ejemplo: error
data objectobligatorio
Datos de la respuesta de error.
errors object[]obligatorio
Lista de errores devueltos para la solicitud.
Array [
errorMessagestringobligatorio
Código de error estable y legible por máquina.
Ejemplo: internalServerError
errorTypestringobligatorio
Categoría del error.
Ejemplo: GENERAL
errorIdstringobligatorio
Identificador único y corto del error para soporte y registros.
Ejemplo: errTest1234
errorDescriptionstringobligatorio
Descripción legible del error.
Ejemplo: Internal server error
errorFieldstringnullable
Campo de la solicitud relacionado con el error, si lo hay.
Ejemplo: null
paramsobject[]obligatorio
Parámetros adicionales del error.
requestParamsobjectobligatorio
Parámetros de la solicitud guardados para diagnóstico.
]

Ejemplo

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