Crear factura cripto de recarga

POST 
/api/invoice/crypto-invoice/deposit

Crea una factura cripto de recarga para un pedido de sandbox del comercio.

Solicitud

application/json

Body

Cuerpo de la solicitudobligatorio

Datos para crear una factura cripto de recarga.

receiverCurrencystringobligatorio
Moneda del destinatario.
Valores posibles: [USD, EUR, USDT, USDC]
Ejemplo: USD
senderCurrencystringobligatorio
Moneda del remitente.
Valores posibles: [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]
Ejemplo: USD
amountnumberobligatorio
Monto.
Valores posibles: >= 0
Ejemplo: 10.25
transferActionstringobligatorio
Acción de la transferencia.
Valores posibles: [GIVE, GET]
Ejemplo: GIVE
notestringnullable
Nota.
Valores posibles: <= 255 caracteres
Ejemplo: Sandbox transfer note
sciNamestringnullable
Nombre de SCI.
Ejemplo: test-value
orderIdstringnullable
ID del pedido.
Valores posibles: <= 64 caracteres
Ejemplo: ORDER_123456
subMerchantURLstringnullable
URL del subcomercio.
Ejemplo: test-value

Ejemplo

{
  "receiverCurrency": "USD",
  "senderCurrency": "BTC",
  "amount": 10.25,
  "transferAction": "GIVE",
  "note": "Sandbox transfer note",
  "sciName": "test-value",
  "orderId": "ORDER_123456",
  "subMerchantURL": "test-value"
}

Respuestas

200

OK

application/json

Esquema

Esquema

receiverCurrencystringobligatorio
Moneda del destinatario.
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
senderCurrencystringobligatorio
Moneda del remitente.
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
amountnumberobligatorio
Monto.
Valores posibles: >= 0
Ejemplo: 10.25
transferActionstringobligatorio
Acción de la transferencia.
Valores posibles: [GIVE, GET]
Ejemplo: GIVE
notestringnullable
Nota.
Valores posibles: <= 255 caracteres
Ejemplo: Sandbox transfer note
sciNamestringnullable
Nombre de SCI.
Ejemplo: test-value
orderIdstringnullable
ID del pedido.
Valores posibles: <= 64 caracteres
Ejemplo: ORDER_123456
subMerchantURLstringnullable
URL del subcomercio.
Ejemplo: test-value
addressstringnullable
Dirección.
Ejemplo: test-value
addressOldFormatstringnullable
Dirección en formato antiguo.
Ejemplo: test-value
destinationTagstringnullable
Destination tag.
Ejemplo: test-value
senderAmountnumbernullable
Monto del remitente.
Ejemplo: 10.25
receiverAmountnumbernullable
Monto del destinatario.
Ejemplo: 10.25
expirationDatedate-timenullable

Fecha de vencimiento.

expirationDateMillisint64nullable

Fecha de vencimiento en milisegundos.

Ejemplo

{
  "receiverCurrency": "USD",
  "senderCurrency": "USD",
  "amount": 10.25,
  "transferAction": "GIVE",
  "note": "Sandbox transfer note",
  "sciName": "test-value",
  "orderId": "ORDER_123456",
  "subMerchantURL": "test-value",
  "address": "test-value",
  "addressOldFormat": "test-value",
  "destinationTag": "test-value",
  "senderAmount": 10.25,
  "receiverAmount": 10.25,
  "expirationDate": "2026-01-15T10:30:00",
  "expirationDateMillis": "2026-01-15T10:30:00"
}

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