Obtener pedido de pago

GET /api/orders

Devuelve información de un pedido de pago SCI por el ID de pedido del comercio y, opcionalmente, el nombre de SCI.

Solicitud

Parámetros Query

orderId stringobligatorio

Valores posibles: <= 64 caracteres

Identificador del pedido del comercio.

Ejemplo: test-order-001

sciName string

Nombre de la integración SCI, opcional.

Ejemplo: sandbox-sci

Respuestas

application/json

Esquema
Ejemplo

Esquema

orderIdstring

ID del pedido.

Ejemplo: ORDER_123456

sciNamestring

Nombre de SCI.

Ejemplo: test-value

paymentStatusstring

Estado del pago.

Valores posibles: [PENDING, COMPLETED, CANCELED, REFUNDED]

Ejemplo: COMPLETED

paymentMethodstring

Método de pago.

Valores posibles: [INTERNAL_OTHERS, CRYPTO_INVOICE]

Ejemplo: CRYPTO_INVOICE

paymentCreateddate-time

Fecha de creación del pago.

transaction object

Esquema Payment Order Transaction Dto.

iduuid

ID.

Ejemplo: 11111111-1111-4111-8111-111111111111

statusstring

Estado.

Valores posibles: [PENDING, COMPLETED, CANCELED, REFUNDED]

Ejemplo: COMPLETED

senderAmountnumber

Monto del remitente.

Ejemplo: 10.25

senderCurrencystring

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

receiverAmountnumber

Monto del destinatario.

Ejemplo: 10.25

receiverCurrencystring

Moneda del destinatario.

Ejemplo: USD

createddate-time

Fecha de creación.

completeddate-time

Fecha de finalización.

canceleddate-time

Fecha de cancelación.

notestring

Nota.

Ejemplo: Sandbox transfer note

srcWalletIdstring

ID de la billetera de origen.

Ejemplo: USD880390848110

buyerEmailstring

Email del comprador.

Ejemplo: [email protected]

invoice object

Esquema Payment Order Invoice Dto.

createddate-time

Fecha de creación.

receiveddate-time

Fecha de recepción.

completeddate-time

Fecha de finalización.

refundRequesteddate-time

Fecha de solicitud de reembolso.

refundeddate-time

Fecha de reembolso.

externalStatusstring

Estado externo.

Valores posibles: [NEW, EXPIRED, PAYMENT_RECEIVED, UNDERPAYMENT_RECEIVED, OVERPAYMENT_RECEIVED, EXPIRED_PAYMENT_RECEIVED, EXPIRED_UNDERPAYMENT_RECEIVED, EXPIRED_OVERPAYMENT_RECEIVED, EXPIRED_PAYMENT_REFUND_REQUESTED, UNDERPAYMENT_REFUND_REQUESTED, EXPIRED_UNDERPAYMENT_REFUND_REQUESTED, OVERPAYMENT_REFUND_REQUESTED, FULL_OVERPAYMENT_REFUND_REQUESTED, EXPIRED_PAYMENT_REFUNDED, UNDERPAYMENT_REFUNDED, OVERPAYMENT_REFUNDED, FULL_OVERPAYMENT_REFUNDED, EXPIRED_PAYMENT_REFUND_CONFIRMATION_REQUIRED, UNDERPAYMENT_REFUND_CONFIRMATION_REQUIRED, EXPIRED_UNDERPAYMENT_REFUND_CONFIRMATION_REQUIRED, OVERPAYMENT_REFUND_CONFIRMATION_REQUIRED, FULL_OVERPAYMENT_REFUND_CONFIRMATION_REQUIRED, CLOSED]

Ejemplo: NEW

invoiceStatusstring

Estado de la factura.

Valores posibles: [NEW, RECEIVED, EXCHANGING, COMPLETED, REFUND_CONFIRMATION, REFUND_REQUESTED, REFUNDED, CLOSED]

Ejemplo: NEW

penaltiesstring[]

Penalizaciones.

Valores posibles: [EXPIRED, UNDERPAYMENT, OVERPAYMENT]

Ejemplo: ["EXPIRED"]

refundTypestring

Tipo de reembolso.

Valores posibles: [FULL_REFUND, PARTIAL_REFUND]

Ejemplo: FULL_REFUND

cryptoCurrencyAddressstring

Dirección cripto.

Ejemplo: USD

initialSenderAmountnumber

Monto inicial del remitente.

Ejemplo: 10.25

actualReceivedAmountnumber

Monto recibido real.

Ejemplo: 10.25

senderCurrencystring

Moneda del remitente.

Ejemplo: USD

cryptoCurrencyTransactionIdstring

ID de la transacción cripto.

Ejemplo: 11111111-1111-4111-8111-111111111111

refundAddressstring

Dirección de reembolso.

Ejemplo: test-value

{
  "orderId": "ORDER_123456",
  "sciName": "test-value",
  "paymentStatus": "CREATED",
  "paymentMethod": "CRYPTO_INVOICE",
  "paymentCreated": "2026-01-15T10:30:00",
  "transaction": {
    "status": "success"
  },
  "invoice": {
    "status": "success"
  }
}

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

application/json

Esquema
Ejemplo

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.

]

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

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

application/json

Esquema
Ejemplo

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.

]

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

No encontrado. El recurso solicitado no existe.

application/json

Esquema
Ejemplo

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.

]

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

Error interno del servidor. Error inesperado, contacta al soporte

application/json

Esquema
Ejemplo

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.

]

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

Obtener pedido de pago

/api/orders

Solicitud​

Parámetros Query

Respuestas​

Solicitud

Respuestas