Diccionario de datos (glosario)

Glosario consolidado de 305 campos de las APIs de SPIDI (Productos y Merchant), tomado de los esquemas del contrato. Es transversal a ambas APIs.

Buscar un campo

Pulsa Ctrl/Cmd + K y escribe el nombre del campo (p. ej. webhook_url, amountReference). Cada entrada indica su tipo, una descripción y, cuando aplica, dónde se usa.

---

accessToken

string

Token JWT para usar en los headers Authorization.

Ejemplo: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Usado en:

• POST/api/v1/merchants/auth/login(Response (200))

accountBank

object

Sin descripción disponible.

Propiedades del objeto:

• number:
• rif:
• phoneNumber:

accountBank_id

string (uuid)

Identificador único de la cuenta bancaria en nuestros sistemas.

accountsBank

array

Sin descripción disponible.

accreditSpidi_id

number

ID de la acreditación en SPIDI.

Ejemplo: 40

action_date

string (date-time)

Fecha y hora de la acción del pagador, en formato ISO 8601 con sufijo Z (UTC).

Usado en:

• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))

active_now

array

Conjunto actual de todas las Solicitudes SPIDI activas en una parada, únicamente con estado 'pending'.

Usado en:

• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (201))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (207))

added

array

Lista de Solicitudes SPIDI recién agregadas a una Parada.

Usado en:

• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (201))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (207))

address

string

Dirección del comercio.

Ejemplo: "Av. Principal, Edif. Central"

Usado en:

• POST/api/v1/merchants(Request)

adjustedDebit

number

Monto ajustado del débito.

agreement_id

string (uuid)

Identificador único del acuerdo de liquidación. Debe ser UUID v4.

Usado en:

• POST/api/v1/ext/agreements(Response (200))
• POST/api/v1/ext/payment-sessions/buttons(Request)
• POST/api/v1/ext/payment-sessions/buttons(Response (400))
• POST/api/v1/ext/payment-sessions/buttons(Response (401))
• POST/api/v1/ext/payment-sessions/buttons(Response (422))
• POST/api/v1/ext/payment-sessions/buttons(Response (500))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Request)
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

agreement_rules

array

(**En Desarrollo**) Reglas de acuerdo. En caso de usar origin_bank_code y destination_bank_account_id, se aplicará una regla de ruteo por banco de origen. Cada regla define a qué cuenta bancaria se debe enviar el dinero según el banco del pagador.

agreementRecipient_id

string (uuid)

UUID global SPIDI del agreement de recepción. Este ID se usará en acuerdos de distribución para identificar al receptor del split. (Requerido en distribution)

allowAmountChange

boolean

Si es true, permite editar el monto en el POS.

Usado en:

• POST/api/v1/merchants/{merchantId}/transactions(Request)
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Request)

already_present

array

Lista de Solicitudes SPIDI que ya estaban activas en una Parada.

Usado en:

• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (201))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (207))

amount

number (double)

Monto en la moneda especificada en el tipo de moneda'currency' con 2 decimales

Ejemplo: "100.01"

Usado en:

• GET/api/v1/ext/payment-stops/{stop\_id}(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (200))
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

amountAccredit

number (double)

Monto en bolívares con 2 decimales que especifica la cantidad de dinero que sera acreditado en la cuenta recaudadora. Notese que este campo incluye conceptos de la logica de negocio de SPIDI por lo que no deberia ser usado en las api publicas

Ejemplo: "100.01"

amountCrypto

number (double)

Monto pagado en criptomoneda.

amountReference

number (double)

Monto de referencia en la moneda especificada en currencyReference con 2 decimales.

Ejemplo: "100.001"

Usado en:

• POST/api/v1/merchants/{merchantId}/transactions(Request)
• POST/api/v1/merchants/{merchantId}/transactions(Response (201))
• GET/api/v1/merchants/{merchantId}/transactions/{orderId}(Response (200))
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Request)
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Response (200))
• GET/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}(Response (200))
• POST/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}/commit(Request)
• POST/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}/commit(Response (200))

amountVes

number (double)

Monto en bolívares con 2 decimales.

amountVesCalculate

number (double)

Monto en bolívares. Si el currency_reference es diferente a VES, este monto se calculó con base a la tasa. Posee 2 decimales

amountVesCheck

number (double)

Monto en bolívares liquidado.

amountVesCredited

number (double)

Monto neto acreditado al receptor en bolívares, luego de aplicar las comisiones correspondientes. Siempre tiene 2 decimales.

Ejemplo: "100.01"

amountWithoutDecimals

number (integer)

Monto en la moneda especificada en el tipo de moneda'currency' sin decimales

Ejemplo: "100"

android_id

string

Sin descripción disponible.

Ejemplo: "xxxx"

app_instance_id

string

Sin descripción disponible.

Ejemplo: "uuid-generado-por-speedypos"

applied_order

array

Orden final aplicado a las Solicitudes SPIDI en una parada.

Usado en:

• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (200))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (207))

authentication--loginValidationError

string

Error general de autenticación.

Ejemplo: "The provided credentials are incorrect"

authorization--loginValidationError

string

Error de autorización.

Ejemplo: "Invalid or missing Bearer token"

bank_code

string

Código del banco. Solo acepta 3–4 dígitos (p.ej., 105 o 0137).

Usado en:

• POST/api/v1/ext/partner(Request)

bank_commissions_ves

number (decimal(12,2))

Comisión bancaria total cobrada en bolívares para la liquidación. Eco del request: no.

Usado en:

• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))

bank_name

string

Nombre comercial del banco. Eco del request: no.

Usado en:

• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))

bank_reference_id

string

Referencia bancaria del pago. Eco del request: no.

Usado en:

• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))

bankCode

string

Código del banco. Solo acepta 3–4 dígitos (p.ej., 105 o 0137).

Usado en:

• GET/api/v1/merchants/{merchantId}/pos-terminals/{serialNumber}/settlements(Response (200))
• GET/api/v1/pos-terminals/{serialNumber}/settlements(Response (200))
• POST/api/v1/pos-terminals/{serialNumber}/settlements(Request)
• POST/api/v1/pos-terminals/{serialNumber}/settlements(Response (200))
• GET/api/v1/pos-terminals/{serialNumber}/settlements/{batchNumber}(Response (200))

bankTransactionId

string

ID de la transacción bancaria.

batch_active_now

array

Conjunto final de activos tras la operación (operación replace)

batch_added

array

Sesiones agregadas como activas (operación add)

batch_already_present

array

Sesiones ya activas, no-op (operación add)

batch_errors

object

Detalle de errores solo si success=false en operaciones batch

batch_id

string

Identificador único de un lote (batch) procesado.

Ejemplo: "batch_54fa7a9e-31f1-41f0-a6b9-2cd05662c721"

Usado en:

• POST/api/v1/ext/payment-stops(Response (200))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (201))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (207))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (200))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (207))

batch_operation_payment_stops_payment_sessions_item

object

Sin descripción disponible.

Propiedades del objeto:

• stop_id:string

  Identificador de la Parada sobre la que se ejecuta la operación. Debe pertenecer al comercio autenticado.

  Ejemplo: "stp_111"

• op:string

  Operación a ejecutar: **add** (agregar sesiones), **remove** (desasociar sesiones), **replace** (reemplazar conjunto activo), **clear** (limpiar todos los activos)

  Valores posibles: add, remove, replace, clear

  Ejemplo: "add"

• session_ids:array

  IDs de sesiones involucradas. Requerido para operaciones add, remove y replace. Solo sesiones en estado **pending** pueden activarse (add/replace).

  Ejemplo: ["sess_A","sess_B"]

bcv_exchange_rate

number (double)

Tasa oficial usada para la conversión

Ejemplo: 122.58

Usado en:

• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (200))

bcv_rate_eur_ves

number (decimal(10,4))

Tasa oficial BCV de EUR a VES usada en el cálculo del monto en bolívares. Eco del request: no.

Usado en:

• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))

bcv_rate_usd_ves

number (decimal(10,4))

Tasa oficial BCV de USD a VES usada en el cálculo del monto en bolívares. Eco del request: no.

Usado en:

• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))

branch

string

Sin descripción disponible.

Ejemplo: "Sucursal Chacao"

button_config

array

Configuración dinámica opcional para personalizar la experiencia comercial del botón de pago.

cancellation_category

string

**Clasificación técnica obligatoria.** Permite segmentar el motivo de cancelación para análisis de conversión y auditoría. **Definiciones:** * INCORRECT\_DATA: Datos de pago o cliente inválidos (ej. CI/RIF erróneo). * ALTERNATIVE\_PAYMENT\_RECEIVED: El cliente pagó por otra vía (ej. efectivo o transferencia directa). * OTHER: Motivos no clasificados previamente (requiere nota adicional).

Ejemplo: "INCORRECT_DATA"

cancellation_categoryCompleted

string

**Clasificación técnica obligatoria.** Permite segmentar el motivo de cancelación para análisis de conversión y auditoría. **Definiciones:** * INCORRECT\_DATA: Datos de pago o cliente inválidos (ej. CI/RIF erróneo). * ALTERNATIVE\_PAYMENT\_RECEIVED: El cliente pagó por otra vía (ej. efectivo o transferencia directa). * ORDER\_SUPERSEDED: La orden fue reemplazada por una nueva versión o corrección. * CUSTOMER\_REQUEST: El cliente solicitó explícitamente cancelar la intención de compra. * INVENTORY\_UNAVAILABILITY: Ruptura de stock o servicio no disponible al momento de procesar. * FRAUD\_SUSPICION: Bloqueo preventivo por patrones de riesgo o validación de seguridad fallida. * DUPLICATE\_SESSION: Se detectó otra sesión activa para la misma operación. * ADMINISTRATIVE\_OVERRIDE: Cancelación forzada por un administrador del sistema o soporte técnico. * OTHER: Motivos no clasificados previamente (requiere nota adicional).

Ejemplo: "INCORRECT_DATA"

cancellation_messageAudit

string

Nota de auditoría interna. Espacio para justificaciones técnicas o administrativas. Este contenido no es visible para el cliente final y se utiliza exclusivamente para trazabilidad recomienda usarlo con esta estructura: (quién, cuándo, por qué).

Ejemplo: "La orden se habia generado de forma automatizada pero el usuario liquido la la sesión en nuestra sucursal por medio de pagos en efectivo."

cancellation_messageUser

string

Mensaje para el usuario final cuado por ejemplo el administrador necesita dar una instrucción específica.

Ejemplo: "Sesión cancelada por pago en efectivo"

cancellationDara

Sin descripción disponible.

Usado en:

• POST/api/v1/merchants/{merchantId}/transactions(Response (201))
• GET/api/v1/merchants/{merchantId}/transactions/{orderId}(Response (200))
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Response (200))
• GET/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}(Response (200))
• POST/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}/commit(Response (200))

cleared

boolean

Indica si se aplicó una operación de limpieza (op=clear) sobre las Solicitudes SPIDI activas en la parada.

Usado en:

• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (201))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (207))

clientIdentification

string

Cédula o RIF del cliente.

Ejemplo: "V14143800"

Usado en:

• POST/api/v1/merchants/{merchantId}/transactions(Request)
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Request)

commissionCharged

boolean

Indica si se cobró comisión.

commissionDebitId

number

ID del débito de comisión.

commitAt

string (date-time)

Fecha y hora de la confirmacion de la operacion (ISO 8601).

Usado en:

• POST/api/v1/merchants/{merchantId}/transactions(Response (201))
• GET/api/v1/merchants/{merchantId}/transactions/{orderId}(Response (200))
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Response (200))
• GET/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}(Response (200))
• POST/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}/commit(Request)
• POST/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}/commit(Response (200))

concept

string

Concepto de la transacción.

confirmData

object

Datos de confirmación bancaria. **Este campo SOLO está definido y presente cuando el 'status' es 'PAID_COMPLETE'.** En estados pendientes o cancelados, este campo será null o no existirá.

Propiedades del objeto:

• authorizationCode:string

  Código de autorización bancaria.

  Ejemplo: "171599"

• processCode:string

  Ejemplo: "002000"

• commitAt:

• amountReference:

• terminalNumber:

• trace:string

  Número de traza (Trace).

  Ejemplo: "000535"

• utcDate:string

  Timestamp UTC del banco.

  Ejemplo: "1007151715"

• cardTypeForRpt:string

  Tipo de tarjeta (C=Crédito, D=Débito).

  Ejemplo: "C"

• visOrMccCard:string

  Franquicia de la tarjeta.

  Ejemplo: "MCC"

• batchNumber:

Usado en:

• POST/api/v1/merchants/{merchantId}/transactions(Response (201))
• GET/api/v1/merchants/{merchantId}/transactions/{orderId}(Response (200))
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Response (200))
• GET/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}(Response (200))
• POST/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}/commit(Response (200))

confReceiptMethodCrixtoForValidation

object

Define la configuracion para el método de recepción de los fondos en la validaciones: * Si type=movil-pay: Se recibe el dinero en la cuenta recaudadora usando pago móvil. * Si type=transfer: Se recibe el dinero en la cuenta recaudadora usando transferencias inmediatas este campo hace que sea necesario pasarle el campo amountAccredit . * Si type=wallet: Se recibe el dinero en la wallet de Spidi.

Propiedades del objeto:

• type:
• amountAccredit:

container_session_id

string

ID de la sesión contenedora cuando el pago se realizó vía container.

continueOnerror

boolean

Indica si el procesamiento debe continuar con el resto de los ítems aunque alguno falle en operaciones de batch.

• Si es false, se detiene en el primer error y las operaciones ya exitosas permanecen válidas.
• Si es true, continúa procesando hasta el final y luego reporta las fallas acumuladas.

Ejemplo: true

created_at

string (date-time)

Fecha y hora de creación del recurso en formato ISO 8601.

Usado en:

• POST/api/v1/ext/agreements(Response (200))
• POST/api/v1/ext/payment-sessions/buttons(Response (200))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Response (200))
• POST/api/v1/ext/split-receiving-agreements(Response (200))
• GET/api/v1/ext/payment-stops(Response (200))
• POST/api/v1/ext/payment-stops(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (200))
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

created_by

string

Identificador del usuario que creó el recurso administrable.

Usado en:

• POST/api/v1/ext/agreements(Response (200))
• POST/api/v1/ext/split-receiving-agreements(Response (200))

createdAt

string (date-time)

Fecha y hora de creación en formato ISO 8601.

Usado en:

• POST/api/v1/merchants(Response (201))

createDate

string (date-time)

Fecha de creación.

creditSpidi_id

string

ID de la liquidación al receptor del pago.

creditWebhook

object

Sin descripción disponible.

Propiedades del objeto:

• id:string
• amount_ves_credited:
• bank_commissions_ves:
• receive_date:
• bank_name:
• bank_reference_id:
• recipient:

crypto

boolean

Indica si se permiten pagos con criptomonedas en la configuración correspondiente. La liquidación siempre ocurre en bolívares.

Usado en:

• POST/api/v1/ext/agreements(Request)
• POST/api/v1/ext/agreements(Response (200))

currency

string

Moneda en la que se realiza la transacción.

Usado en:

• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

currency_crypto

string

Moneda cripto utilizada en el pago (por ejemplo, USDT).

Usado en:

• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))

currencyReference

string

Moneda de referencia que se fija para el pago. Usada para calcular el monto en bolívares con la tasa vigente.

Usado en:

• POST/api/v1/merchants/{merchantId}/transactions(Request)
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Request)
• GET/api/v1/merchants/{merchantId}/pos-terminals/{serialNumber}/settlements(Response (200))
• GET/api/v1/pos-terminals/{serialNumber}/settlements(Response (200))
• POST/api/v1/pos-terminals/{serialNumber}/settlements(Request)
• POST/api/v1/pos-terminals/{serialNumber}/settlements(Response (200))
• GET/api/v1/pos-terminals/{serialNumber}/settlements/{batchNumber}(Response (200))

cursor_by_stop

object

Mapa de cursores por parada para continuar la paginación de sesiones en múltiples paradas, usando pares stop\_id → cursor obtenidos de una respuesta previa.

Usado en:

• POST/api/v1/ext/payment-stops/payment-sessions/query(Request)
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

customer_ref

string

Referencia del cliente asociada a una sesión o parada.

Usado en:

• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

data

object

Objeto principal de datos de la operación, que contiene el cuerpo del recurso creado, consultado o afectado (acuerdo, sesión, parada, webhook, etc.).

Usado en:

• POST/api/v1/merchants(Response (201))
• POST/api/v1/merchants/auth/login(Response (200))
• POST/api/v1/merchants/{merchantId}/pos-terminals/{serialNumber}/pairing(Response (200))
• POST/api/v1/pos-terminals/{serialNumber}/pairing/activate(Response (200))
• POST/api/v1/merchants/{merchantId}/transactions(Response (201))
• GET/api/v1/merchants/{merchantId}/transactions/{orderId}(Response (200))
• POST/api/v1/merchants/{merchantId}/transactions/{orderId}/cancellation(Response (200))
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Response (200))
• GET/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}(Response (200))
• POST/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}/commit(Response (200))
• POST/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}/cancellation/commit(Response (200))
• GET/api/v1/merchants/{merchantId}/pos-terminals/{serialNumber}/settlements(Response (200))
• GET/api/v1/pos-terminals/{serialNumber}/settlements(Response (200))
• POST/api/v1/pos-terminals/{serialNumber}/settlements(Response (200))
• POST/api/v1/ext/agreements(Response (200))
• POST/api/v1/ext/partner(Response (201))
• POST/api/v1/ext/payment-sessions/buttons(Response (200))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Response (400))
• POST/api/v1/ext/payment-sessions/request/batch(Response (401))
• POST/api/v1/ext/payment-sessions/request/batch(Response (403))
• POST/api/v1/ext/payment-sessions/request/batch(Response (409))
• POST/api/v1/ext/payment-sessions/request/batch(Response (422))
• POST/api/v1/ext/payment-sessions/request/batch(Response (500))
• POST/api/v1/payment-session/{session\_id}/expiration(Response (200))
• POST/api/v1/ext/split-receiving-agreements(Response (200))
• GET/api/v1/ext/payment-stops(Response (200))
• POST/api/v1/ext/payment-stops(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}(Response (200))
• PATCH/api/v1/ext/payment-stops/{stop\_id}(Response (200))
• DELETE/api/v1/ext/payment-stops/{stop\_id}(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (200))

date

string (date)

Fecha

Ejemplo: "2025-15-01"

Usado en:

• POST/api/v1/ext/payment-sessions/buttons(Request)
• POST/api/v1/ext/payment-sessions/buttons(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Request)
• POST/api/v1/ext/payment-sessions/request/batch(Response (200))

debit_status

string

Estado del débito.

debitId

string

Identificador del débito (string para path).

deeplinkConfig

object

Configuración para el retorno a la app (Deep Linking). Estos campos se usan cuando la app merchant se ubica en el punto, pues al terminar la transacción de compra, el app financiero va a abrir la app en la pantalla específica esperada por parte del merchant.

Propiedades del objeto:

• returnPackage:string

  Ejemplo: "com.tuapp.kiosco"

• returnActivity:string

  Ejemplo: "com.tuapp.kiosco.PaymentResultActivity"

Usado en:

• POST/api/v1/merchants/{merchantId}/transactions(Request)
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Request)

default_bank_account_id

string (uuid)

UUID de la cuenta bancaria por defecto que se utilizará para la liquidación.

Usado en:

• POST/api/v1/ext/agreements(Request)
• POST/api/v1/ext/agreements(Response (200))
• POST/api/v1/ext/split-receiving-agreements(Request)
• POST/api/v1/ext/split-receiving-agreements(Response (200))
• POST/api/v1/ext/split-receiving-agreements(Response (400))
• POST/api/v1/ext/split-receiving-agreements(Response (401))
• POST/api/v1/ext/split-receiving-agreements(Response (409))
• POST/api/v1/ext/split-receiving-agreements(Response (422))
• POST/api/v1/ext/split-receiving-agreements(Response (500))

deleted_at

string (date-time)

Fecha y hora de eliminación expresada en formato ISO 8601.

Usado en:

• DELETE/api/v1/ext/payment-stops/{stop\_id}(Response (200))

description

string

Descripción del acuerdo o del concepto de pago asociado a una sesión.

Usado en:

• POST/api/v1/ext/agreements(Request)
• POST/api/v1/ext/agreements(Response (200))
• POST/api/v1/ext/payment-sessions/buttons(Request)
• POST/api/v1/ext/payment-sessions/buttons(Response (200))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Request)
• POST/api/v1/ext/payment-sessions/request/batch(Response (200))
• POST/api/v1/ext/split-receiving-agreements(Request)
• POST/api/v1/ext/split-receiving-agreements(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (200))

destination_bank_account_id

string

UUID de la cuenta bancaria de destino para un banco de origen específico.

Usado en:

• POST/api/v1/ext/agreements(Request)
• POST/api/v1/ext/agreements(Response (200))
• POST/api/v1/ext/split-receiving-agreements(Request)
• POST/api/v1/ext/split-receiving-agreements(Response (200))
• POST/api/v1/ext/split-receiving-agreements(Response (400))
• POST/api/v1/ext/split-receiving-agreements(Response (401))
• POST/api/v1/ext/split-receiving-agreements(Response (409))
• POST/api/v1/ext/split-receiving-agreements(Response (422))
• POST/api/v1/ext/split-receiving-agreements(Response (500))

device_fingerprint

string

opcional

device_serial

string

Sin descripción disponible.

Ejemplo: "ABC123456"

distribution

array

Lista de reglas/destinatarios del split. Debe tener ≥ 1 ítem. La suma de amount_reference debe ser menor al amount total de la sesión, porque la diferencia restante se asigna automáticamente al owner, quien siempre debe recibir una parte del pago. (Requerido cuando split=true)

Usado en:

• POST/api/v1/ext/payment-sessions/buttons(Request)
• POST/api/v1/ext/payment-sessions/buttons(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Request)
• POST/api/v1/ext/payment-sessions/request/batch(Response (200))

due_date_link

string (date-time)

Fecha y hora límite de vencimiento de la Solicitud SPIDI (link).

Usado en:

• GET/api/v1/ext/payment-stops/{stop\_id}(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (200))

due_date_reached_behavior

string

Comportamiento configurado para cuando la sesión alcance su fecha de vencimiento.

Usado en:

• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Request)
• POST/api/v1/ext/payment-sessions/request/batch(Response (200))

due_date_session

string (date-time)

Fecha y hora límite de vencimiento de la Solicitud SPIDI (sesión).

Usado en:

• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Request)
• POST/api/v1/ext/payment-sessions/request/batch(Response (200))

duplicates

array

Lista de IDs repetidos detectados al procesar una operación de reordenamiento o batch.

Usado en:

• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (200))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (207))

durationMinutes

integer

Duración en minutos de la sesión.

Ejemplo: 5

email

string (email)

Dirección de correo electrónico.

Ejemplo: "admin@comercio.com"

Usado en:

• POST/api/v1/merchants(Request)
• POST/api/v1/merchants/auth/login(Request)
• POST/api/v1/ext/partner(Response (201))

error

object

Objeto de error que contiene información estructurada sobre el código y el mensaje de error cuando la operación no es exitosa. Eco del request: no.

Usado en:

• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

errors

object

Detalles específicos de los errores de validación.

Usado en:

• POST/api/v1/merchants(Response (400))
• POST/api/v1/merchants/auth/login(Response (401))
• POST/api/v1/merchants/{merchantId}/pos-terminals/{serialNumber}/pairing(Response (400))
• POST/api/v1/pos-terminals/{serialNumber}/pairing/activate(Response (400))
• POST/api/v1/merchants/{merchantId}/transactions(Response (400))
• GET/api/v1/merchants/{merchantId}/transactions/{orderId}(Response (404))
• POST/api/v1/merchants/{merchantId}/transactions/{orderId}/cancellation(Response (409))
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Response (400))
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Response (401))
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Response (403))
• GET/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}(Response (404))
• POST/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}/commit(Response (409))
• POST/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}/cancellation/commit(Response (409))
• GET/api/v1/merchants/{merchantId}/pos-terminals/{serialNumber}/settlements(Response (400))
• POST/api/v1/pos-terminals/{serialNumber}/settlements(Response (400))
• GET/api/v1/pos-terminals/{serialNumber}/settlements/{batchNumber}(Response (404))
• POST/api/spidipagos/login(Response (400))
• POST/api/spidipagos/login(Response (401))
• POST/api/spidipagos/login(Response (422))
• POST/api/spidipagos/login(Response (429))
• POST/api/spidipagos/login(Response (500))
• POST/api/v1/ext/agreements(Response (400))
• POST/api/v1/ext/agreements(Response (401))
• POST/api/v1/ext/agreements(Response (403))
• POST/api/v1/ext/agreements(Response (409))
• POST/api/v1/ext/agreements(Response (422))
• POST/api/v1/ext/agreements(Response (429))
• POST/api/v1/ext/agreements(Response (500))
• POST/api/v1/ext/payment-sessions/buttons(Response (400))
• POST/api/v1/ext/payment-sessions/buttons(Response (401))
• POST/api/v1/ext/payment-sessions/buttons(Response (422))
• POST/api/v1/ext/payment-sessions/buttons(Response (500))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (400))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (401))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (403))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (404))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (422))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (500))
• POST/api/v1/ext/payment-sessions/request/batch(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Response (400))
• POST/api/v1/ext/payment-sessions/request/batch(Response (401))
• POST/api/v1/ext/payment-sessions/request/batch(Response (403))
• POST/api/v1/ext/payment-sessions/request/batch(Response (409))
• POST/api/v1/ext/payment-sessions/request/batch(Response (422))
• POST/api/v1/ext/payment-sessions/request/batch(Response (500))
• POST/api/v1/payment-session/{session\_id}/expiration(Response (422))
• POST/api/v1/ext/split-receiving-agreements(Response (400))
• POST/api/v1/ext/split-receiving-agreements(Response (401))
• POST/api/v1/ext/split-receiving-agreements(Response (409))
• POST/api/v1/ext/split-receiving-agreements(Response (422))
• POST/api/v1/ext/split-receiving-agreements(Response (500))
• GET/api/v1/ext/payment-stops(Response (400))
• POST/api/v1/ext/payment-stops(Response (200))
• POST/api/v1/ext/payment-stops(Response (400))
• POST/api/v1/ext/payment-stops(Response (401))
• POST/api/v1/ext/payment-stops(Response (422))
• POST/api/v1/ext/payment-stops(Response (500))
• GET/api/v1/ext/payment-stops/{stop\_id}(Response (404))
• PATCH/api/v1/ext/payment-stops/{stop\_id}(Response (400))
• PATCH/api/v1/ext/payment-stops/{stop\_id}(Response (401))
• PATCH/api/v1/ext/payment-stops/{stop\_id}(Response (422))
• PATCH/api/v1/ext/payment-stops/{stop\_id}(Response (500))
• DELETE/api/v1/ext/payment-stops/{stop\_id}(Response (400))
• DELETE/api/v1/ext/payment-stops/{stop\_id}(Response (403))
• DELETE/api/v1/ext/payment-stops/{stop\_id}(Response (404))
• DELETE/api/v1/ext/payment-stops/{stop\_id}(Response (500))
• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (400))
• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (404))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (201))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (207))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (400))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (401))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (409))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (422))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (429))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (500))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (200))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (207))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (400))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (401))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (409))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (422))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (429))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (500))
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (400))
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (401))
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (403))
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (422))
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (500))

event

string

Tipo de evento reportado en un webhook, indicando la acción ocurrida. Eco del request: no.

exchange_rate_from

string

Moneda base utilizada en la tasa de cambio aplicada (por ejemplo, una moneda fuerte desde la cual se convierte a VES). Este campo puede estar obsoleto en el nuevo estándar. Eco del request: no.

Usado en:

• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (200))

exchange_rate_to

string

Moneda destino utilizada en la tasa de cambio aplicada, típicamente la moneda local (VES) a la que se convierte. Este campo puede estar obsoleto en el nuevo estándar. Eco del request: no.

Usado en:

• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (200))

expirationBehavior

string

Comportamiento aplicado a la sesión o enlace cuando se maneja su expiración. Eco del request: no.

expire_behavior_link

string

Comportamiento configurado para la Solicitud SPIDI cuando alcanza su fecha de vencimiento.

Usado en:

• GET/api/v1/ext/payment-stops/{stop\_id}(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (200))

expiredAt

string (date-time)

Fecha y hora en que la Solicitud SPIDI pasó al estado 'expired', en formato ISO 8601. (incluye solo cuando la sesión expira)

expiresIn

integer

Tiempo en segundos antes de expirar.

Ejemplo: 3600

Usado en:

• POST/api/v1/merchants/auth/login(Response (200))

failed_count

integer

Número de sesiones que fallaron al crear en el batch.

Usado en:

• POST/api/v1/ext/payment-sessions/request/batch(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Response (400))
• POST/api/v1/ext/payment-sessions/request/batch(Response (401))
• POST/api/v1/ext/payment-sessions/request/batch(Response (403))
• POST/api/v1/ext/payment-sessions/request/batch(Response (409))
• POST/api/v1/ext/payment-sessions/request/batch(Response (422))
• POST/api/v1/ext/payment-sessions/request/batch(Response (500))

failure_url

string (uri)

URL de redirección que se utiliza cuando un intento de pago falle.

Usado en:

• POST/api/v1/ext/payment-sessions/buttons(Request)
• POST/api/v1/ext/payment-sessions/buttons(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Request)
• POST/api/v1/ext/payment-sessions/request/batch(Response (200))

field

string

Error genérico de campo.

Ejemplo: "Invalid field value"

Usado en:

• POST/api/v1/ext/agreements(Response (400))
• POST/api/v1/ext/agreements(Response (401))
• POST/api/v1/ext/agreements(Response (403))
• POST/api/v1/ext/agreements(Response (409))
• POST/api/v1/ext/agreements(Response (422))
• POST/api/v1/ext/agreements(Response (429))
• POST/api/v1/ext/agreements(Response (500))
• POST/api/v1/ext/payment-sessions/buttons(Response (400))
• POST/api/v1/ext/payment-sessions/buttons(Response (401))
• POST/api/v1/ext/payment-sessions/buttons(Response (422))
• POST/api/v1/ext/payment-sessions/buttons(Response (500))

from_date

string (date-time)

Fecha y hora mínima (inclusive) desde la cual devolver resultados. Formato ISO 8601 UTC.

has_next

boolean

Indica si existe una página siguiente en los resultados de la paginación. Eco del request: no.

Usado en:

• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

id

string (uuid)

Identificador único en formato UUID.

Usado en:

• POST/api/v1/merchants(Response (201))
• POST/api/v1/merchants/{merchantId}/transactions(Response (201))
• GET/api/v1/merchants/{merchantId}/transactions/{orderId}(Response (200))
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Response (200))
• GET/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}(Response (200))
• POST/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}/commit(Response (200))
• GET/api/v1/merchants/{merchantId}/pos-terminals/{serialNumber}/settlements(Response (200))
• GET/api/v1/pos-terminals/{serialNumber}/settlements(Response (200))
• POST/api/v1/pos-terminals/{serialNumber}/settlements(Request)
• POST/api/v1/pos-terminals/{serialNumber}/settlements(Response (200))
• GET/api/v1/pos-terminals/{serialNumber}/settlements/{batchNumber}(Response (200))

idempotency_key

string

Error relacionado con la clave de idempotencia.

Ejemplo: "This idempotency key has already been used"

Usado en:

• POST/api/v1/ext/payment-sessions/buttons(Response (400))
• POST/api/v1/ext/payment-sessions/buttons(Response (401))
• POST/api/v1/ext/payment-sessions/buttons(Response (422))
• POST/api/v1/ext/payment-sessions/buttons(Response (500))

idempotency-key

string (uuid)

Clave de idempotencia para evitar duplicados. Debe ser UUID v4.

identification

string

Identificación del usuario o cliente.

Usado en:

• POST/api/v1/ext/partner(Request)
• POST/api/v1/ext/partner(Response (201))

identificationLegal

string

Identificación legal puede ser RIF o CI

identifier

string

Identificador del pagador, interpretado según el valor de identifier_label. Ejemplo: Nro de orden, Nombre, etc.

Usado en:

• POST/api/v1/ext/payment-sessions/buttons(Request)
• POST/api/v1/ext/payment-sessions/buttons(Response (200))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Request)
• POST/api/v1/ext/payment-sessions/request/batch(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (200))

identifier_label

string

Etiqueta que indica cómo debe interpretarse el valor enviado en identifier (ej. 'Nro de orden').

Usado en:

• POST/api/v1/ext/payment-sessions/buttons(Request)
• POST/api/v1/ext/payment-sessions/buttons(Response (200))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Request)
• POST/api/v1/ext/payment-sessions/request/batch(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (200))

imei

string

opcional_si_existe

immediate_debit

boolean

Indica si permite pagos con débito inmediato.

Usado en:

• POST/api/v1/ext/agreements(Request)
• POST/api/v1/ext/agreements(Response (200))

inboundCrixto_id

string

ID de la orden en Crixto

Ejemplo: "392"

inboundCrixto_paymentDeeplink

string

Deeplink para realizar el pago en la app del proveedor (ej. Binance).

inboundCrixto_paymentMethod_commission

number (double)

Monto en decimales de comisión aplicado por el procesador tecnológico (BinancePay, CrixtoPay, etc) por la validación, ejecución y aseguramiento de la transacción de pago.

Ejemplo: 0.003

inboundCrixto_paymentMethod_name

string

Nombre del método de pago (ej. Binance Pay, Crixto Pay).

inboundCrixto_posType

string

Numero que indica la forma en que se reciben los pagos desde crixto 3 para recibir dinero en la wallet, 2 pago movil, ...

Ejemplo: "3"

inboundCrixto_provider_commission

number (double)

Monto en decimales de comisión retenido por el provedor (Crixto, Binance, etc) por la gestión de fondos o el uso de su infraestructura de billetera.

Ejemplo: 0.016

inboundCrixto_qrPayment

object

Código QR para realizar el pago

Propiedades del objeto:

• img:string

  Imagen del código QR en formato base64

  Ejemplo: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAALQAAAC0CAYAAAA9zQYyAAAAAklEQVR4AewaftIAAAdiSURBVO3BQY4cy5LAQDLR978yR0tfBZCoav2nGDezP1jrEg9rXeRhrYs8rHWRh7Uu8rDWRR7WusjDWhd5WOsiD2td5GGtizysdZGHtS7ysNZFHta6yMNaF/nhQyp/U8WkMlW8ofJGxRsqU8Wk8kbFpDJVTCpTxRsqf1PFJx7WusjDWhd5WOsiP3xZxTepvKEyVUwqU8UnVKaKE5WTihOV/6WKb1L5poe1LvKw1kUe1rrID79M5Y2KNypOVN5QOal4o+JE5Y2KE5W/SeWNit/0sNZFHta6yMNaF/nhH6cyVUwVb1RMKpPKVDGpTBWTylRxojJVfEJlqrjJw1oXeVjrIg9rXeSHf1zFpPJGxRsVv0nlDZWpYlI5UZkq/mUPa13kYa2LPKx1kR9+WcV/ScWJyonKVDFVfFPFJypOVD5R8V/ysNZFHta6yMNaF/nhy1T+JpWpYlI5UZkqJpWpYlKZKiaVqWJSmSomlaniDZWp4hMq/2UPa13kYa2LPKx1EfuDf5jKScUbKlPFpDJVTCrfVHGiMlWcqJxU/Mse1rrIw1oXeVjrIj98SGWqmFROKiaVNypOVKaKk4o3VKaKE5WTihOVqeJE5aTiRGWqOFGZKiaVk4pPPKx1kYe1LvKw1kV++FDFScWJyknFN6mcVPymihOVqWKqOFGZKt5QmSp+U8U3Pax1kYe1LvKw1kV++JDKVDGpTBVvqEwVk8pJxaQyVUwqU8VJxf8nKm+oTBW/6WGtizysdZGHtS7yw4cqTipOKt5QmSpOVKaKSWWqmFQ+oXJSMVVMKt+kMlW8UXGi8r/0sNZFHta6yMNaF7E/+EUqU8WkMlVMKlPFicobFZ9QOak4UZkqTlS+qWJSOamYVL6p4hMPa13kYa2LPKx1kR8+pDJVfFPFGxUnKm+onFS8ofKJijdUTlSmikllUnmj4kTlmx7WusjDWhd5WOsi9gcfUDmpmFSmihOVk4pJZap4Q+Wk4kTljYoTlaliUjmpeENlqjhRmSomlaniNz2sdZGHtS7ysNZF7A++SGWqOFGZKr5JZaqYVKaKE5WpYlI5qZhU3qh4Q+WkYlL5RMUbKlPFJx7WusjDWhd5WOsiP/wylU+onFScVJxUfELlmyreUJkqPlFxojJVTConFVPFNz2sdZGHtS7ysNZF7A9+kcpJxaQyVUwqU8UnVKaKSWWqmFSmihOVNyreUHmj4kTlpOJE5Y2KTzysdZGHtS7ysNZFfvgylaliUplUTlSmijdUpoqp4g2Vb6o4UZkq3qiYVD5RMalMFf9LD2td5GGtizysdZEfPqQyVZxUfJPKJ1SmiqniDZXfpDJVTBVvqJxUvKEyVUwqU8U3Pax1kYe1LvKw1kV++FDFpDJVTCpTxYnKScUbKn9TxYnKScUnVKaKSeUNlZOKk4pJZar4xMNaF3lY6yIPa13khw+pTBUnFScqU8WkMqlMFd+kMlWcVJyoTBVvqEwVJxXfVHGiMlVMKlPFNz2sdZGHtS7ysNZF7A8+oPJGxaQyVUwqb1RMKp+oOFE5qXhD5RMVk8pU8QmVqeINlanimx7WusjDWhd5WOsi9gd/kcpUMalMFd+k8kbFJ1SmihOVb6qYVN6oOFF5o2JSmSo+8bDWRR7WusjDWhexP/gilU9UTCpTxaQyVUwqv6niROVvqjhR+U0Vk8obFZ94WOsiD2td5GGti/zwyypOVE4qJpUTlU9UvKEyVZxUTCpTxYnKGyonFZPKScWkMqlMFZPKb3pY6yIPa13kYa2L/PCXqUwVJypTxYnKb1J5o2JS+aaKSeWkYlKZKk5UpopJZVI5qfimh7Uu8rDWRR7WusgPH1KZKiaVqWJSOamYVE4qTlSmiknlpGJSeaPiRGWqeKNiUjmpOFF5o+INlaniEw9rXeRhrYs8rHWRHz5U8YbKGyonFZ9QOamYVKaKE5WpYlI5UZkqTlTeUPmEylQxqUwVv+lhrYs8rHWRh7Uu8sMvq/hNKicVn1B5Q2WqeKPiROWk4hMVb6j8lzysdZGHtS7ysNZFfviQyt9UcVJxUnGi8obKJyomlaliqnhDZap4Q2Wq+ITKb3pY6yIPa13kYa2L/PBlFd+k8obKVHGiMlWcqEwV31QxqUwVJypTxaTyRsUnKk5UvulhrYs8rHWRh7Uu8sMvU3mj4o2KN1ROVKaKqeINlanib1KZKiaVSeUTKlPFpDJVfNPDWhd5WOsiD2td5Id/nMpU8YmKSeWk4hMqn1A5qZhUTiomlaliUvkveVjrIg9rXeRhrYv8cBmVk4pJ5aTiRGWqOFE5qThRmSomlU+o/Mse1rrIw1oXeVjrIj/8sorfVHGiclJxojJVvFFxonKi8psq3lB5Q2Wq+E0Pa13kYa2LPKx1kR++TOVvUpkqvqliUjlReaPiEyonKm+onFRMKm+onFR84mGtizysdZGHtS5if7DWJR7WusjDWhd5WOsiD2td5GGtizysdZGHtS7ysNZFHta6yMNaF3lY6yIPa13kYa2LPKx1kYe1LvJ/zXq8jxPRiswAAAAASUVORK5CYII="

• url:string

  URL para realizar el pago

  Ejemplo: "https://app.binance.com/qr/dplk42fce9f3e97f43cead255ea26f43a458"

inboundCrixto_rateCryptoFiat

number (double)

Tasa Cripto/Fiat usada durante la conversión de cripto-fiat, especificada 4 decimales

Ejemplo: 157.7837

inboundCrixto_urlPayment

string

URL a la que se redirige en caso de éxito o si se genera un error.

inboundCrixto_webhook_url

string

URL a la que se enviará la información al finalizar el proceso.

Ejemplo: "https://miapi.com/spidi/webhook"

inboundCrypto_amountPayByUserCrypto

number (double)

Monto con 3 decimales del pago realizado por el usuario en la moneda cripto. Note que puede variar del monto original si se aplica una comisión por el pago.

Ejemplo: 157.783

inboundCrypto_amountPayByUserVes

number (double)

Monto con 3 decimales del pago realizado por el usuario en la moneda VES. Note que puede variar del monto original si se aplica una comisión por el pago.

Ejemplo: 157.783

inboundCrypto_amountTransactionCrypto

number (double)

Monto con 3 decimales de la transacción en la moneda cripto. Note que es el monto original sin incluir la comisión por el pago.

Ejemplo: 157.783

inboundCrypto_amountTransactionVes

number (double)

Monto con 3 decimales de la transacción en la moneda VES. Note que es el monto original sin incluir la comisión por el pago.

Ejemplo: 157.783

inboundCrypto_details

object

Detalles de pago con criptomonedas (null si no aplica).

Propiedades del objeto:

• provider_name:
• crypto_order_id:
• payment_method_name:
• amount_transaction_ves:
• amount_pay_by_user_crypto:
• currency_crypto:
• exchange_rate:
• paid_at:

inboundCrypto_id

string

Identificador de la orden cripto generada por el proveedor.

inboundCrypto_paidAt

string (date-time)

Fecha y hora en que se confirmó el pago cripto, en formato ISO 8601.

inboundCrypto_provider_name

string

Nombre de la entidad o plataforma financiera que custodia los activos del usuario. Representa el ecosistema o 'banco digital' donde reside el saldo original (ej. Binance, Crixto).

inboundCrypto_status

string

Estado del pago cripto: 'EXPIRED' (el pago expiró), 'PAID' (el usuario realizó el pago) y 'PENDING' (a la espera del pago por parte del usuario).

inboundCrypto_statusConvertion

string

Estado de la transacción de conversión de cripto a fiat: 'PAID' (La transacción fue completada exitosamente), 'PENDING' (a la espera de la confirmación de la transacción) y 'ERROR' (la transacción falló).

inboundType

string

El discriminador del tipo de inbound. Cuando el valor es crixto-binance-pay se recibiran pagos de Binance Pay a través de Crixto

Ejemplo: "crixto-binance-pay"

include_history

boolean

Indica si debe incluirse el histórico de estados (paid, expired). Valor por defecto: true.

instrument

string

Instrumento de pago utilizado.

internal_reference

string

Referencia interna única utilizada por el sistema o el comercio para identificar la solicitud de pago o parada (propósito estrictamente técnico,no visible al usuario final). **Importancia para Paradas SPIDI:**

• Permite conciliar y auditar operaciones entre tu sistema y SPIDI
• Sirve para asociar solicitudes de pago con su Parada correspondiente
• Puede vincularse a clientes, contratos o facturas en tu plataforma Se recomienda mantener este campo de forma consistente para facilitar la trazabilidad.

Ejemplo: "8233232"

Usado en:

• POST/api/v1/ext/payment-sessions/request/batch(Request)
• POST/api/v1/ext/payment-sessions/request/batch(Response (200))
• GET/api/v1/ext/payment-stops(Response (200))
• POST/api/v1/ext/payment-stops(Request)
• POST/api/v1/ext/payment-stops(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}(Response (200))
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

item_index

integer

Índice del ítem que falló en un batch.

Usado en:

• POST/api/v1/ext/payment-sessions/request/batch(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Response (400))
• POST/api/v1/ext/payment-sessions/request/batch(Response (401))
• POST/api/v1/ext/payment-sessions/request/batch(Response (403))
• POST/api/v1/ext/payment-sessions/request/batch(Response (409))
• POST/api/v1/ext/payment-sessions/request/batch(Response (422))
• POST/api/v1/ext/payment-sessions/request/batch(Response (500))

items

array

Listado de objetos para creación de paradas o sesiones (batch). Mínimo un ítem.

Usado en:

• POST/api/v1/ext/payment-sessions/request/batch(Request)
• POST/api/v1/ext/payment-sessions/request/batch(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Response (400))
• POST/api/v1/ext/payment-sessions/request/batch(Response (401))
• POST/api/v1/ext/payment-sessions/request/batch(Response (403))
• POST/api/v1/ext/payment-sessions/request/batch(Response (409))
• POST/api/v1/ext/payment-sessions/request/batch(Response (422))
• POST/api/v1/ext/payment-sessions/request/batch(Response (500))
• GET/api/v1/ext/payment-stops(Response (200))
• POST/api/v1/ext/payment-stops(Request)
• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (200))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Request)
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Request)
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

label

string

Etiqueta descriptiva del receptor en un split. (Opcional en distribution, Eco del request: sí)

Usado en:

• POST/api/v1/ext/payment-sessions/buttons(Request)
• POST/api/v1/ext/payment-sessions/buttons(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Request)
• POST/api/v1/ext/payment-sessions/request/batch(Response (200))

landing_title

string

Título de la landing page creada por SPIDI.

Ejemplo: "Pago de Servicios"

last_expired_at

string (date-time)

Fecha y hora de la última expiración en formato ISO 8601.

last_expired_by

string

Origen de la expiración: api o system.

Usado en:

• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))

late_notice_message

string

Mensaje que verá el pagador cuando la sesión haya vencido pero continúe activa (keep_active).

Usado en:

• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Request)
• POST/api/v1/ext/payment-sessions/request/batch(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (200))

legalName

string

Nombre legal del comercio.

Ejemplo: "Inversiones Spidi C.A."

Usado en:

• POST/api/v1/merchants(Request)
• POST/api/v1/merchants(Response (201))

limit

integer

Máximo de elementos a devolver en una lista. Valor por defecto: 50.

Usado en:

• GET/api/v1/ext/payment-stops(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (200))

link_amount

number (double)

Monto en la moneda de referencia para una solicitud de pago.

Ejemplo: 15.5

link_status

string

Estado del solicitud de pago.

Ejemplo: "pending"

links_active

array

Lista de solicitudes de pago activas en la parada (Nota: Sugerido cambiar a 'requests_active').

Usado en:

• GET/api/v1/ext/payment-stops/{stop\_id}(Response (200))

links_active_count

integer

Número de solicitudes de pago activas (Nota: Sugerido cambiar a 'requests_active_count').

Usado en:

• GET/api/v1/ext/payment-stops(Response (200))

manufacturer

string

Sin descripción disponible.

Ejemplo: "PAX"

memo

string

Nota o referencia interna para el crédito.

Usado en:

• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))

merchant_id

string (uuid)

Identificador único en formato UUID del comercio

Ejemplo: "3ddc4cfb-c09a-43de-92c1-e4a069732e90"

merchant_name

string

Nombre del comercio.

merchant_type

string

Tipo de comercio

Ejemplo: "INDIVIDUAL"

message

string

Mensaje de confirmación o error legible.

Usado en:

• POST/api/v1/merchants(Response (400))
• POST/api/v1/merchants/auth/login(Response (401))
• POST/api/v1/merchants/{merchantId}/pos-terminals/{serialNumber}/pairing(Response (400))
• POST/api/v1/pos-terminals/{serialNumber}/pairing/activate(Response (400))
• POST/api/v1/merchants/{merchantId}/transactions(Response (400))
• GET/api/v1/merchants/{merchantId}/transactions/{orderId}(Response (404))
• POST/api/v1/merchants/{merchantId}/transactions/{orderId}/cancellation(Response (409))
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Response (400))
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Response (401))
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Response (403))
• GET/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}(Response (404))
• POST/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}/commit(Response (409))
• POST/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}/cancellation/commit(Response (409))
• GET/api/v1/merchants/{merchantId}/pos-terminals/{serialNumber}/settlements(Response (400))
• POST/api/v1/pos-terminals/{serialNumber}/settlements(Response (400))
• GET/api/v1/pos-terminals/{serialNumber}/settlements/{batchNumber}(Response (404))
• POST/api/spidipagos/login(Response (400))
• POST/api/spidipagos/login(Response (401))
• POST/api/spidipagos/login(Response (422))
• POST/api/spidipagos/login(Response (429))
• POST/api/spidipagos/login(Response (500))
• POST/api/v1/ext/agreements(Response (400))
• POST/api/v1/ext/agreements(Response (401))
• POST/api/v1/ext/agreements(Response (403))
• POST/api/v1/ext/agreements(Response (409))
• POST/api/v1/ext/agreements(Response (422))
• POST/api/v1/ext/agreements(Response (429))
• POST/api/v1/ext/agreements(Response (500))
• POST/api/v1/ext/partner(Response (201))
• POST/api/v1/ext/payment-sessions/buttons(Response (200))
• POST/api/v1/ext/payment-sessions/buttons(Response (400))
• POST/api/v1/ext/payment-sessions/buttons(Response (401))
• POST/api/v1/ext/payment-sessions/buttons(Response (422))
• POST/api/v1/ext/payment-sessions/buttons(Response (500))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (400))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (401))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (403))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (404))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (422))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (500))
• POST/api/v1/ext/payment-sessions/request/batch(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Response (400))
• POST/api/v1/ext/payment-sessions/request/batch(Response (401))
• POST/api/v1/ext/payment-sessions/request/batch(Response (403))
• POST/api/v1/ext/payment-sessions/request/batch(Response (409))
• POST/api/v1/ext/payment-sessions/request/batch(Response (422))
• POST/api/v1/ext/payment-sessions/request/batch(Response (500))
• POST/api/v1/payment-session/{session\_id}/expiration(Response (200))
• POST/api/v1/payment-session/{session\_id}/expiration(Response (422))
• POST/api/v1/ext/split-receiving-agreements(Response (400))
• POST/api/v1/ext/split-receiving-agreements(Response (401))
• POST/api/v1/ext/split-receiving-agreements(Response (409))
• POST/api/v1/ext/split-receiving-agreements(Response (422))
• POST/api/v1/ext/split-receiving-agreements(Response (500))
• GET/api/v1/ext/payment-stops(Response (200))
• GET/api/v1/ext/payment-stops(Response (400))
• POST/api/v1/ext/payment-stops(Response (200))
• POST/api/v1/ext/payment-stops(Response (400))
• POST/api/v1/ext/payment-stops(Response (401))
• POST/api/v1/ext/payment-stops(Response (422))
• POST/api/v1/ext/payment-stops(Response (500))
• GET/api/v1/ext/payment-stops/{stop\_id}(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}(Response (404))
• PATCH/api/v1/ext/payment-stops/{stop\_id}(Response (200))
• PATCH/api/v1/ext/payment-stops/{stop\_id}(Response (400))
• PATCH/api/v1/ext/payment-stops/{stop\_id}(Response (401))
• PATCH/api/v1/ext/payment-stops/{stop\_id}(Response (422))
• PATCH/api/v1/ext/payment-stops/{stop\_id}(Response (500))
• DELETE/api/v1/ext/payment-stops/{stop\_id}(Response (200))
• DELETE/api/v1/ext/payment-stops/{stop\_id}(Response (400))
• DELETE/api/v1/ext/payment-stops/{stop\_id}(Response (403))
• DELETE/api/v1/ext/payment-stops/{stop\_id}(Response (404))
• DELETE/api/v1/ext/payment-stops/{stop\_id}(Response (500))
• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (400))
• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (404))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (201))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (207))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (400))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (401))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (409))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (422))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (429))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (500))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (200))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (207))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (400))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (401))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (409))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (422))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (429))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (500))
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (400))
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (401))
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (403))
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (422))
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (500))

metadata

object

Datos adicionales definidos por el comercio. Eco del request: no.

Usado en:

• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

missing_actives

array

Solicitudes SPIDI activas no incluidas en la lista durante un reordenamiento.

Usado en:

• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (200))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (207))

mobile_payment

boolean

Permitir pagos con pago móvil.

Usado en:

• POST/api/v1/ext/agreements(Request)
• POST/api/v1/ext/agreements(Response (200))

mode

string

Modo de reordenamiento: 'append' (por defecto) o 'strict' (reemplazar lista).

Usado en:

• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Request)
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (200))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (207))

model

string

Sin descripción disponible.

Ejemplo: "A920"

name

string

Sin descripción disponible.

Ejemplo: "Comercial La Prueba"

Usado en:

• POST/api/v1/ext/partner(Request)
• POST/api/v1/ext/partner(Response (201))
• POST/api/v1/ext/payment-sessions/buttons(Request)
• POST/api/v1/ext/payment-sessions/buttons(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Request)
• POST/api/v1/ext/payment-sessions/request/batch(Response (200))

next_cursor

string

Cursor para continuar la paginación. (Eco del request: no)

Usado en:

• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

not_active

array

Solicitudes SPIDI no activas en Parada.

Usado en:

• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (201))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (207))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (200))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (207))

not_found

array

Sesiones no encontradas en Parada.

Usado en:

• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (201))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (207))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (200))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (207))

number

string

Sin descripción disponible.

Ejemplo: "01020000000000000000"

Usado en:

• GET/api/v1/merchants/{merchantId}/pos-terminals/{serialNumber}/settlements(Response (200))
• GET/api/v1/pos-terminals/{serialNumber}/settlements(Response (200))
• POST/api/v1/pos-terminals/{serialNumber}/settlements(Request)
• POST/api/v1/pos-terminals/{serialNumber}/settlements(Response (200))
• GET/api/v1/pos-terminals/{serialNumber}/settlements/{batchNumber}(Response (200))

numeric_debitId

number

Identificador del débito (numérico para response).

observations

string

Mensaje libre para el partner (máx. 500 caracteres). (Requerido en distribution, Eco del request: sí)

Usado en:

• POST/api/v1/ext/payment-sessions/buttons(Request)
• POST/api/v1/ext/payment-sessions/buttons(Response (200))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Request)
• POST/api/v1/ext/payment-sessions/request/batch(Response (200))

offset

integer

Desplazamiento para paginación (cantidad de elementos a saltar).

Usado en:

• GET/api/v1/ext/payment-stops(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (200))

only_fields

string

Coma-separado para limitar los campos devueltos en el payload.

Usado en:

• POST/api/v1/ext/payment-stops/payment-sessions/query(Request)
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

op

string

Operación para batch: add | remove | replace | clear.

Usado en:

• POST/api/v1/ext/payment-stops/payment-sessions/batch(Request)
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (201))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (207))

order

string

Orden de clasificación: asc (ascendente) o desc (descendente). Por defecto: desc.

Usado en:

• POST/api/v1/ext/payment-stops/payment-sessions/query(Request)
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

order_index

integer

Posición relativa de la sesión en la parada.

Usado en:

• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

orderId

string (uuid)

Identificador único de la orden generado por el comercio.

Ejemplo: "3ddc4cfb-c09a-43de-92c1-e4a069732e90"

Usado en:

• POST/api/v1/merchants/{merchantId}/transactions(Request)
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Request)

origin_bank_code

string

Código oficial del banco de origen.

Usado en:

• POST/api/v1/ext/agreements(Request)
• POST/api/v1/ext/agreements(Response (200))
• POST/api/v1/ext/split-receiving-agreements(Request)
• POST/api/v1/ext/split-receiving-agreements(Response (200))
• POST/api/v1/ext/split-receiving-agreements(Response (400))
• POST/api/v1/ext/split-receiving-agreements(Response (401))
• POST/api/v1/ext/split-receiving-agreements(Response (409))
• POST/api/v1/ext/split-receiving-agreements(Response (422))
• POST/api/v1/ext/split-receiving-agreements(Response (500))

originalOrderId

string

Identificador de la orden original en caso de cancelación.

Ejemplo: "3ddc4cfb-c09a-43de-92c1-e4a069732e90"

owner

object

Datos del crédito recibido por el owner.

Usado en:

• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))

page

integer

Número de página solicitada (Request) o número de página devuelta.

page_size

integer

Cantidad de elementos por página solicitada (Request) o cantidad de elementos devueltos (Response). Eco del request: no.

Usado en:

• POST/api/v1/ext/payment-stops/payment-sessions/query(Request)
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

paid_at

string (date-time)

Fecha y hora del pago en formato ISO 8601. Eco del request: no.

Usado en:

• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (200))
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

paid_origin

object

Origen del pago cuando proviene de container. Incluye container_session_id.

paid_via

string

Indica el tipo de flujo de pago utilizado. Eco del request: no.

partner_email

string (email)

Correo electrónico del partner.

partner_id

string (uuid)

Identificador único del partner.

Usado en:

• POST/api/v1/ext/partner(Response (201))

partner_name

string

Nombre o razón social del partner

partner_observations

string

Mensaje libre para el partner (máx. 500 caracteres). (Requerido en distribution, Eco del request: sí)

partner_phone

string

Teléfono del partner.

partner_phoneOrAccountForPayment

string

Teléfono o número de cuenta para el pago.

partner_rifNumber

string

RIF del partner

partner_shortName

string

Nombre corto del partner. Se genera automáticamente a partir del owner que lo crea seguido de p1 p2 p3 etc

partner_type

string

Tipo de usuario.

partners

array

Listado de créditos extra asociados a partners. (Nota: Posiblemente obsoleto). Eco del request: no.

Usado en:

• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))

password

string

Contraseña de acceso del usuario.

Usado en:

• POST/api/v1/merchants(Request)
• POST/api/v1/merchants/auth/login(Request)
• POST/api/spidipagos/login(Request)
• POST/api/spidipagos/login(Response (400))
• POST/api/spidipagos/login(Response (401))
• POST/api/spidipagos/login(Response (422))
• POST/api/spidipagos/login(Response (429))
• POST/api/spidipagos/login(Response (500))

payer_identifier

string

Identificador del pagador.

payer_name

string

Nombre del pagador.

payment_details

object

Detalles del pago bancario. Es 'null' si no aplica. (Nota: Revisar si es objeto vacío o null). Eco del request: no.

Propiedades del objeto:

• action_date:
• bank_name:
• bank_reference_id:
• amount_ves:
• bcv_rate_usd_ves:
• bcv_rate_eur_ves:
• rate_usdt_ves:
• rate_col_ves:

Usado en:

• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))

payment_method

string

Método de pago utilizado. Eco del request: no.

Usado en:

• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))

payment_methods

array

Métodos de pago permitidos solicitados (Request) o devueltos (Response). Eco del request: no.

Usado en:

• POST/api/v1/ext/agreements(Request)
• POST/api/v1/ext/agreements(Response (200))

payment_url

string

URL de la página segura SPIDI donde quien paga realiza el pago.

Ejemplo: "{{base_url}}/?id=3ddc4cfb-c09a-43de-92c1-e4a069732e90"

Usado en:

• POST/api/v1/ext/payment-sessions/buttons(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (200))
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

paymentDate

Fecha en que se realizo el pago

Ejemplo: "2025-15-01"

paymentMerchant_status

string

Indica el status del pago. PENDING: la orden fue creada y el POS aún no ha confirmado el pago. CANCELED: el sistema merchant canceló la orden antes de la confirmación del POS (si el POS confirma el pago después, este estado es sobrescrito a PAID). PAID: el POS confirmó exitosamente el pago. VOID\_PENDING: se solicitó la anulación de un pago ya confirmado y se espera la confirmación del POS. VOIDED: el POS confirmó la anulación del pago.

Ejemplo: "PAID"

per_stop

object

Configuración de filtros y paginación por parada. Eco del request: no.

Usado en:

• POST/api/v1/ext/payment-stops/payment-sessions/query(Request)
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

phone

string

Número de teléfono.

Ejemplo: "+584141234567"

Usado en:

• POST/api/v1/merchants(Request)
• POST/api/v1/ext/partner(Response (201))

phoneNumber

string

Número de teléfono.

Ejemplo: "+584141234567"

phoneNumberLocal

string

Número de teléfono local.

Ejemplo: "04141234567"

posBatchId

integer

Este campo será un número autoincremental gestionado directamente desde el POS. El POS debe enviarlo para identificar correctamente el número de lote de las operaciones.

Ejemplo: 3

previous_status

string

Estado anterior de la sesión antes de expirar o fallar. Eco del request: no.

problemDetails

object

Detalles del problema. Implementación del estándar RFC 9457 extendido para incluir lista de errores detallados y soporte de retrocompatibilidad multiformato.

Propiedades del objeto:

• status:integer

  El código de estado HTTP generado por el servidor de origen.

• title:string

  Un resumen breve y legible por humanos sobre el tipo de problema.

• type:string (uri-reference)

  Una referencia URI que identifica el tipo de problema.

• detail:string

  Una explicación legible por humanos específica para esta ocurrencia del problema.

• message:

  Este campo se incluyo para que jose puediera crear el endpoint de forma mas sencilla sin embargo se debe priorizar el uso de 'detail' y 'errors' solo se mantendra hasta que jose pueda hacer la migracion.

• instance:string (uri-reference)

  Una referencia URI que identifica la ocurrencia específica del problema.

• errors:array

  Lista de errores específicos de validación con punteros JSON (RFC 6901).

processed_count

integer

Conteo de ítems procesados. Eco del request: no.

Usado en:

• POST/api/v1/ext/payment-sessions/request/batch(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Response (400))
• POST/api/v1/ext/payment-sessions/request/batch(Response (401))
• POST/api/v1/ext/payment-sessions/request/batch(Response (403))
• POST/api/v1/ext/payment-sessions/request/batch(Response (409))
• POST/api/v1/ext/payment-sessions/request/batch(Response (422))
• POST/api/v1/ext/payment-sessions/request/batch(Response (500))

processedAt

string (date-time)

Fecha y hora de procesamiento en formato ISO 8601.

Ejemplo: "2026-05-06T17:15:00-04:00"

processedAtNoUtc

string (date-time)

Fecha y hora de procesamiento en formato local no utc.

Ejemplo: "2026-05-06T17:15:00"

provider

string

Sin descripción disponible.

Ejemplo: "proveedor_x"

q

string

Búsqueda por texto en stop_title y/o internal_reference (contiene).

qr_payment_url

string

Cadena en base64 que representa la imagen de un QR que apunta al payment_url.

Usado en:

• POST/api/v1/ext/payment-sessions/request/batch(Response (200))

qrImgBase64

string

Imagen del código QR en formato Base64.

Ejemplo: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAKQAAACkCAYAAAAZtYVBAAAAAklEQVR4AewaftIAAAZGSURBVO3BQW4ER5IAQfdE..."

rate_col_ves

number (decimal(10,4))

Tasa de cambio COP a VES.

Usado en:

• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))

rate_usdt_ves

number (decimal(10,4))

Tasa de cambio USDT a VES.

Usado en:

• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))

reason

string

Razón de expiración o fallo.

Usado en:

• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))

receipt_url

string (uri)

URL del comprobante de pago SPIDI.

Usado en:

• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

receiptMethodCrixto

string

Define el método de recepción de los fondos: * movil-pay: Se recibe el dinero en la cuenta recaudadora usando pago móvil. * transfer: Se recibe el dinero en la cuenta recaudadora usando tranferencia inmediata. * wallet: Se recibe el dinero en la wallet de Spidi.

receive_date

string (date-time)

Fecha y hora en que se acreditó el pago (ISO 8601).

Usado en:

• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))

receiver_credit.created

string (date-time)

Fecha asociada a la liquidación del receptor del pago.

receiverCredits

object

Detalles de la liquidación de créditos (Owner y Partners).

Propiedades del objeto:

• owner:object

  Crédito asignado al dueño de la cuenta principal.

  • receiver_id:
  • memo:
  • spidi_credit_id:
  • amount_ves_credited:
  • bank_commissions_ves:
  • receive_date:
  • bank_name:
  • bank_reference_id:

• partners:array

  Lista de créditos asignados a partners (split).

receiverCreditsSummary

object

Resumen agregado de liquidaciones al o los receptores.

Propiedades del objeto:

• total_credits:
• total_amount_ves_credited:
• total_bank_commissions_ves:

recipient

object

Sin descripción disponible.

Propiedades del objeto:

• id:

• type:

• split_recipient_agreement_id:

• partner:object

  • observations:
  • name:
  • rif_number:

recipientId

string

Identificador del receptor del crédito.

recipientType

string

Tipo del receptor del crédito.

referenceByUser

string

Referencia proporcionada por el usuario para identificar el pago o transacción.

Ejemplo: "1234567891"

referencePayment

string

Referencia para identificar el pago o transacción.

Ejemplo: "1234567891"

removed

array

Sesiones desasociadas de activos en Parada (op=remove).

Usado en:

• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (201))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (207))

reorder_session_ids

array

Nuevo orden deseado. Deben ser session\_id **activos** en esa Parada (ver mode)

replaced_previous

array

Sesiones que dejaron de estar activas en Parada (op=replace).

Usado en:

• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (201))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (207))

requested

object

Eco de parámetros aplicados en la consulta.

Usado en:

• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

results

array

Resultados por stop_id en operaciones batch o consultas múltiples.

Usado en:

• POST/api/v1/ext/payment-stops(Response (200))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (201))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (207))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (200))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (207))
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

rif

string

Sin descripción disponible.

Ejemplo: "J-00000000-0"

search

string

Texto para buscar por referencias internas u otros campos indexados.

serialPos

string

Serial del POS

Ejemplo: "98202003219630"

serialSettlement

string

Serial del terminal que debe ejecutar el cierre.

Ejemplo: "98202003219630"

session_id

string

Identificador único de la sesión de pago, accedible a través del payment_url.

Usado en:

• POST/api/v1/ext/payment-sessions/buttons(Response (200))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (400))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (401))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (403))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (404))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (422))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (500))
• POST/api/v1/ext/payment-sessions/request/batch(Response (200))
• POST/api/v1/payment-session/{session\_id}/expiration(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (200))
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

session_ids

array

IDs de sesiones involucradas.

Usado en:

• POST/api/v1/ext/payment-stops/payment-sessions/batch(Request)
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Request)

session_origin

string

Origen de la sesión: 'button' (Botón de pago) o 'request' (Solicitud SPIDI).

Usado en:

• POST/api/v1/ext/payment-sessions/buttons(Response (200))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Response (200))

sessionPayment

object

Detalles del pago y estado de la sesión.

Propiedades del objeto:

• payment_method:string

  Método de pago: "crypto", "immediate_debit" o "mobile_payment".

• spidi_transaction_id:integer

  ID de la transacción en Spidi (null si no se ha completado).

• spidi_transaction_url:string

  URL del comprobante de pago (null si no se ha completado).

• due_date_session:string

  Fecha límite para completar el pago (ISO 8601).

• due_date_reached_behavior:string

  Comportamiento al expirar: "keep_active" o "expire".

• late_notice_message:string

  Mensaje para mostrar cuando el pago está atrasado.

• expired_at:string

  Fecha hora ISO 8601 de la expiración más reciente.

• last_expired_by:

• reason:

• user_message:string

  Último Mensaje para el usuario.

• crypto_details:

• payment_details:object

  Detalles del pago bancario (null si no aplica).

• receiver_credits:

• receiver_credits_summary:

sessionPaymentWebhook

object

Sin descripción disponible.

Propiedades del objeto:

• id:
• origin:
• agreement_id:
• currency_reference:
• amount_reference:
• identifier_label:
• identifier:
• description:
• payment_method:

sessionSpidi_id

string

ID de la sesión original en SPIDI.

Ejemplo: "098ace94-ce70-4203-abc3-80e20bb6e4c6"

settlementSummary

object

Sin descripción disponible.

Propiedades del objeto:

• batchNumber:

• transactionCount:integer

  Ejemplo: 12

• closedAt:string (date-time)

  Ejemplo: "2023-04-04T15:26:51.187Z"

• currencyReference:

• terminal:

• debitBatch:string

  Falta ser definido por Carlos Cardenas

signature

string

Firma opcional del payload.

sort

string

Campo de ordenación.

Usado en:

• POST/api/v1/ext/payment-stops/payment-sessions/query(Request)
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

SPIDI-Signature

string

Firma HMAC-SHA256 del cuerpo. (Header HTTP 'SPIDI-Signature').

SPIDI-Timestamp

string (date-time)

Timestamp del evento. (Header HTTP 'SPIDI-Timestamp').

split

object

Configuración de división de pagos (Request) / Eco del request del split (Response).

Propiedades del objeto:

• document:
• distribution:

Usado en:

• POST/api/v1/ext/agreements(Request)
• POST/api/v1/ext/agreements(Response (200))
• POST/api/v1/ext/agreements(Response (400))
• POST/api/v1/ext/agreements(Response (401))
• POST/api/v1/ext/agreements(Response (403))
• POST/api/v1/ext/agreements(Response (409))
• POST/api/v1/ext/agreements(Response (422))
• POST/api/v1/ext/agreements(Response (429))
• POST/api/v1/ext/agreements(Response (500))
• POST/api/v1/ext/payment-sessions/buttons(Request)
• POST/api/v1/ext/payment-sessions/buttons(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Request)
• POST/api/v1/ext/payment-sessions/request/batch(Response (200))

split_general_info

object

Información general del documento asociado al split.

splitDocument

object

Información del documento proporcionado por el owner a los partners para dejar evidencia del split. **Notas importantes:**

• Esta información **no implica cálculo fiscal** por parte de SPIDI; es solo comunicación entre owner y partners.
• splitDocument\_url puede ser público con hash o una URL autenticada.
• SPIDI **no interpreta ni calcula IVA** a partir de esta información; solo lo transporta.

Propiedades del objeto:

• name:
• type:
• date:
• url:
• observations:

splitDocument_date

string (date)

Fecha de emisión del documento en formato ISO 8601 (YYYY-MM-DD).

splitDocument_name

string

Nombre del documento asociado a la transacción split (por ejemplo: factura/recibo/contrato D001-00045678).

splitDocument_observations

string

Observaciones libres del owner (máx. 500 caracteres).

splitDocument_type

string

Formato libre del owner donde especifica el tipo de documento.

splitDocument_url

string (uri)

Enlace para visualizar/descargar el documento del split. Puede ser público con hash o una URL autenticada.

status

string

Estado actual de la sesión. El valor failed solo se aplica para sesiones creadas con botón de pago.

Usado en:

• POST/api/v1/merchants(Response (201))
• POST/api/v1/merchants(Response (400))
• POST/api/v1/merchants/auth/login(Response (200))
• POST/api/v1/merchants/auth/login(Response (401))
• POST/api/v1/merchants/{merchantId}/pos-terminals/{serialNumber}/pairing(Response (200))
• POST/api/v1/merchants/{merchantId}/pos-terminals/{serialNumber}/pairing(Response (400))
• POST/api/v1/pos-terminals/{serialNumber}/pairing/activate(Response (200))
• POST/api/v1/pos-terminals/{serialNumber}/pairing/activate(Response (400))
• POST/api/v1/merchants/{merchantId}/transactions(Response (201))
• POST/api/v1/merchants/{merchantId}/transactions(Response (400))
• GET/api/v1/merchants/{merchantId}/transactions/{orderId}(Response (200))
• GET/api/v1/merchants/{merchantId}/transactions/{orderId}(Response (404))
• POST/api/v1/merchants/{merchantId}/transactions/{orderId}/cancellation(Response (200))
• POST/api/v1/merchants/{merchantId}/transactions/{orderId}/cancellation(Response (409))
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Response (200))
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Response (400))
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Response (401))
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Response (403))
• GET/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}(Response (200))
• GET/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}(Response (404))
• POST/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}/commit(Response (200))
• POST/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}/commit(Response (409))
• POST/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}/cancellation/commit(Response (200))
• POST/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}/cancellation/commit(Response (409))
• GET/api/v1/merchants/{merchantId}/pos-terminals/{serialNumber}/settlements(Response (200))
• GET/api/v1/merchants/{merchantId}/pos-terminals/{serialNumber}/settlements(Response (400))
• GET/api/v1/pos-terminals/{serialNumber}/settlements(Response (200))
• POST/api/v1/pos-terminals/{serialNumber}/settlements(Response (200))
• POST/api/v1/pos-terminals/{serialNumber}/settlements(Response (400))
• GET/api/v1/pos-terminals/{serialNumber}/settlements/{batchNumber}(Response (404))
• POST/api/v1/ext/agreements(Response (200))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))
• POST/api/v1/payment-session/{session\_id}/expiration(Response (200))
• GET/api/v1/ext/payment-stops(Response (200))
• POST/api/v1/ext/payment-stops(Request)
• POST/api/v1/ext/payment-stops(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}(Response (200))
• PATCH/api/v1/ext/payment-stops/{stop\_id}(Request)
• PATCH/api/v1/ext/payment-stops/{stop\_id}(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (200))
• POST/api/v1/ext/payment-stops/payment-sessions/query(Request)
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

statusHttp_code

integer

Código de estado HTTP interno de la transacción.

Ejemplo: 200

statusHttp_shortDescription

string

Estado textual de la operación.

Ejemplo: "Success"

statusInboundCrixtoOrder

string

Estado del pago de crixto

stop

object

Sin descripción disponible.

Propiedades del objeto:

• stop_id:
• stop_url:
• stop_title:
• internal_reference:
• empty_state_message:
• status:
• created_at:

stop_emptyStateMessage

string

Mensaje personalizado mostrado al cliente cuando la Parada no tiene solicitudes de pago activas (estado Empty). Ejemplo: 'No tienes pagos pendientes' o 'Actualmente no hay deudas asociadas'.

Ejemplo: "No tienes pagos pendientes"

stop_id

string (uuid)

Identificador único de la Parada SPIDI en formato UUID. Este ID identifica de forma permanente el espacio donde el cliente puede consultar y gestionar todas sus solicitudes de pago.

Ejemplo: "stp_f9317c1b-8a4f-4d7e-9f25-3a2b8b9a4f12"

Usado en:

• GET/api/v1/ext/payment-stops(Response (200))
• POST/api/v1/ext/payment-stops(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}(Response (200))
• PATCH/api/v1/ext/payment-stops/{stop\_id}(Response (200))
• DELETE/api/v1/ext/payment-stops/{stop\_id}(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (200))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Request)
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (201))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (207))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Request)
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (200))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (207))
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

stop_ids

array

Lista de IDs de Paradas a consultar.

Usado en:

• POST/api/v1/ext/payment-stops/payment-sessions/query(Request)
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

stop_status

string

Estado de la Parada SPIDI. **Estados disponibles:**

• **active**: La parada está activa. Si tiene al menos un enlace de pago activo, se muestran los pagos disponibles en una lista con su identificador, monto y estado. Si no tiene solicitudes de pago activas (estado Empty), muestra el mensaje configurado en empty\_state\_message.
• **disabled**: La parada está deshabilitada temporalmente. Los clientes no pueden acceder a ella, pero puede reactivarse cambiando el estado a active. **Nota:** Aunque no aparece en el enum, existe un estado **deleted** que indica que la parada fue eliminada definitivamente y no puede recuperarse.

Ejemplo: "active"

stop_statusInitial

string

Estado inicial de la parada

Ejemplo: "active"

stop_title

string

Título visible de la Parada SPIDI mostrado al cliente. Generalmente se usa el nombre del cliente, contrato o servicio asociado.

Ejemplo: "Federico Díaz"

Usado en:

• GET/api/v1/ext/payment-stops(Response (200))
• POST/api/v1/ext/payment-stops(Request)
• POST/api/v1/ext/payment-stops(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}(Response (200))
• PATCH/api/v1/ext/payment-stops/{stop\_id}(Request)
• PATCH/api/v1/ext/payment-stops/{stop\_id}(Response (200))

stop_url

string (uri)

URL permanente y única de la Parada SPIDI. El cliente puede visitar esta URL en cualquier momento para consultar y pagar todas sus solicitudes de pago activas o históricas, sin necesidad de recibir nuevos enlaces cada vez.

Ejemplo: "https://mispidi.com/s/stp\_f9317c1b-8a4f-4d7e-9f25-3a2b8b9a4f12"

Usado en:

• GET/api/v1/ext/payment-stops(Response (200))
• POST/api/v1/ext/payment-stops(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}(Response (200))
• PATCH/api/v1/ext/payment-stops/{stop\_id}(Response (200))

success

boolean

Indica si la operación fue exitosa. True si el endpoint se procesó de forma exitosa. False de lo contrario

Ejemplo: true

Usado en:

• POST/api/spidipagos/login(Response (400))
• POST/api/spidipagos/login(Response (401))
• POST/api/spidipagos/login(Response (422))
• POST/api/spidipagos/login(Response (429))
• POST/api/spidipagos/login(Response (500))
• POST/api/v1/ext/agreements(Response (200))
• POST/api/v1/ext/agreements(Response (400))
• POST/api/v1/ext/agreements(Response (401))
• POST/api/v1/ext/agreements(Response (403))
• POST/api/v1/ext/agreements(Response (409))
• POST/api/v1/ext/agreements(Response (422))
• POST/api/v1/ext/agreements(Response (429))
• POST/api/v1/ext/agreements(Response (500))
• POST/api/v1/ext/partner(Response (201))
• POST/api/v1/ext/payment-sessions/buttons(Response (200))
• POST/api/v1/ext/payment-sessions/buttons(Response (400))
• POST/api/v1/ext/payment-sessions/buttons(Response (401))
• POST/api/v1/ext/payment-sessions/buttons(Response (422))
• POST/api/v1/ext/payment-sessions/buttons(Response (500))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (400))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (401))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (403))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (404))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (422))
• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (500))
• POST/api/v1/ext/payment-sessions/request/batch(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Response (400))
• POST/api/v1/ext/payment-sessions/request/batch(Response (401))
• POST/api/v1/ext/payment-sessions/request/batch(Response (403))
• POST/api/v1/ext/payment-sessions/request/batch(Response (409))
• POST/api/v1/ext/payment-sessions/request/batch(Response (422))
• POST/api/v1/ext/payment-sessions/request/batch(Response (500))
• POST/api/v1/payment-session/{session\_id}/expiration(Response (200))
• POST/api/v1/payment-session/{session\_id}/expiration(Response (422))
• POST/api/v1/ext/split-receiving-agreements(Response (200))
• POST/api/v1/ext/split-receiving-agreements(Response (400))
• POST/api/v1/ext/split-receiving-agreements(Response (401))
• POST/api/v1/ext/split-receiving-agreements(Response (409))
• POST/api/v1/ext/split-receiving-agreements(Response (422))
• POST/api/v1/ext/split-receiving-agreements(Response (500))
• GET/api/v1/ext/payment-stops(Response (200))
• GET/api/v1/ext/payment-stops(Response (400))
• POST/api/v1/ext/payment-stops(Response (200))
• POST/api/v1/ext/payment-stops(Response (400))
• POST/api/v1/ext/payment-stops(Response (401))
• POST/api/v1/ext/payment-stops(Response (422))
• POST/api/v1/ext/payment-stops(Response (500))
• GET/api/v1/ext/payment-stops/{stop\_id}(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}(Response (404))
• PATCH/api/v1/ext/payment-stops/{stop\_id}(Response (200))
• PATCH/api/v1/ext/payment-stops/{stop\_id}(Response (400))
• PATCH/api/v1/ext/payment-stops/{stop\_id}(Response (401))
• PATCH/api/v1/ext/payment-stops/{stop\_id}(Response (422))
• PATCH/api/v1/ext/payment-stops/{stop\_id}(Response (500))
• DELETE/api/v1/ext/payment-stops/{stop\_id}(Response (200))
• DELETE/api/v1/ext/payment-stops/{stop\_id}(Response (400))
• DELETE/api/v1/ext/payment-stops/{stop\_id}(Response (403))
• DELETE/api/v1/ext/payment-stops/{stop\_id}(Response (404))
• DELETE/api/v1/ext/payment-stops/{stop\_id}(Response (500))
• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (400))
• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (404))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (201))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (207))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (400))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (401))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (409))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (422))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (429))
• POST/api/v1/ext/payment-stops/payment-sessions/batch(Response (500))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (200))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (207))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (400))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (401))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (409))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (422))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (429))
• PATCH/api/v1/ext/payment-stops/payment-sessions/reorder(Response (500))
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (400))
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (401))
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (403))
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (422))
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (500))

success_url

string (uri)

URL de redirección que se utiliza cuando un intento de pago es exitoso.

Usado en:

• POST/api/v1/ext/payment-sessions/buttons(Request)
• POST/api/v1/ext/payment-sessions/buttons(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Request)
• POST/api/v1/ext/payment-sessions/request/batch(Response (200))

successDetails

object

Detalles del éxito. Estándar basado en la estructura de 'Problem Details' (RFC 9457) para estandarizar las respuestas exitosas en toda la arquitectura de microservicios.

Propiedades del objeto:

• status:integer

  El código de estado HTTP generado por el servidor de origen (ej. 200, 201).

• title:string

  Un resumen breve y legible por humanos sobre el tipo de éxito.

• detail:string

  Una explicación legible por humanos específica para esta ocurrencia del éxito.

• data:

  Contenedor de información que puede almacenar un objeto único o una lista de objetos.

successDetailsArray

object

Variante de SuccessDetails donde 'data' es estrictamente un arreglo de objetos.

Propiedades del objeto:

• status:integer

• title:string

• detail:string

• data:array

  Representa una colección de entidades de negocio.

successDetailsObject

object

Variante de SuccessDetails donde 'data' es estrictamente un objeto único.

Propiedades del objeto:

• status:integer

• title:string

• detail:string

• data:object

  Representa una entidad única de negocio.

successful_count

integer

Número de sesiones creadas exitosamente.

Usado en:

• POST/api/v1/ext/payment-sessions/request/batch(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Response (400))
• POST/api/v1/ext/payment-sessions/request/batch(Response (401))
• POST/api/v1/ext/payment-sessions/request/batch(Response (403))
• POST/api/v1/ext/payment-sessions/request/batch(Response (409))
• POST/api/v1/ext/payment-sessions/request/batch(Response (422))
• POST/api/v1/ext/payment-sessions/request/batch(Response (500))

taxId

string

RIF o identificación fiscal del comercio.

Ejemplo: "J-12345678-0"

Usado en:

• POST/api/v1/merchants(Request)

terminal

object

Sin descripción disponible.

Propiedades del objeto:

• id:string

  Ejemplo: "TMS ID"

• affiliateCode:string

  Ejemplo: "0010800050"

• number:

• serial:

• bankId:string

  Ejemplo: "3"

• bankCode:

Usado en:

• GET/api/v1/merchants/{merchantId}/pos-terminals/{serialNumber}/settlements(Response (200))
• GET/api/v1/pos-terminals/{serialNumber}/settlements(Response (200))
• POST/api/v1/pos-terminals/{serialNumber}/settlements(Request)
• POST/api/v1/pos-terminals/{serialNumber}/settlements(Response (200))
• GET/api/v1/pos-terminals/{serialNumber}/settlements/{batchNumber}(Response (200))

terminal_id

string (uuid)

Id único del terminal en formato UUID.

Ejemplo: "3ddc4cfb-c09a-43de-92c1-e4a069732e90"

terminal_number

string

Numero de terminal.

Ejemplo: "98202003219630"

terminal_serial

string

Serial del terminal físico.

Ejemplo: "98202003219630"

terminal_status

string

Sin descripción disponible.

Ejemplo: "pending"

timestamp

string (date-time)

Fecha y hora del evento (ISO 8601).

title

string

Título visible.

Usado en:

• POST/api/v1/merchants(Response (201))
• POST/api/v1/merchants(Response (400))
• POST/api/v1/merchants/auth/login(Response (200))
• POST/api/v1/merchants/auth/login(Response (401))
• POST/api/v1/merchants/{merchantId}/pos-terminals/{serialNumber}/pairing(Response (200))
• POST/api/v1/merchants/{merchantId}/pos-terminals/{serialNumber}/pairing(Response (400))
• POST/api/v1/pos-terminals/{serialNumber}/pairing/activate(Response (200))
• POST/api/v1/pos-terminals/{serialNumber}/pairing/activate(Response (400))
• POST/api/v1/merchants/{merchantId}/transactions(Response (201))
• POST/api/v1/merchants/{merchantId}/transactions(Response (400))
• GET/api/v1/merchants/{merchantId}/transactions/{orderId}(Response (200))
• GET/api/v1/merchants/{merchantId}/transactions/{orderId}(Response (404))
• POST/api/v1/merchants/{merchantId}/transactions/{orderId}/cancellation(Response (200))
• POST/api/v1/merchants/{merchantId}/transactions/{orderId}/cancellation(Response (409))
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Response (200))
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Response (400))
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Response (401))
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Response (403))
• GET/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}(Response (200))
• GET/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}(Response (404))
• POST/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}/commit(Response (200))
• POST/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}/commit(Response (409))
• POST/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}/cancellation/commit(Response (200))
• POST/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}/cancellation/commit(Response (409))
• GET/api/v1/merchants/{merchantId}/pos-terminals/{serialNumber}/settlements(Response (200))
• GET/api/v1/merchants/{merchantId}/pos-terminals/{serialNumber}/settlements(Response (400))
• GET/api/v1/pos-terminals/{serialNumber}/settlements(Response (200))
• POST/api/v1/pos-terminals/{serialNumber}/settlements(Response (200))
• POST/api/v1/pos-terminals/{serialNumber}/settlements(Response (400))
• GET/api/v1/pos-terminals/{serialNumber}/settlements/{batchNumber}(Response (404))
• POST/api/v1/ext/agreements(Request)
• POST/api/v1/ext/agreements(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Request)
• POST/api/v1/ext/split-receiving-agreements(Request)
• POST/api/v1/ext/split-receiving-agreements(Response (200))
• POST/api/v1/ext/split-receiving-agreements(Response (400))
• POST/api/v1/ext/split-receiving-agreements(Response (401))
• POST/api/v1/ext/split-receiving-agreements(Response (409))
• POST/api/v1/ext/split-receiving-agreements(Response (422))
• POST/api/v1/ext/split-receiving-agreements(Response (500))

to_date

string (date-time)

Fecha/hora máxima (inclusive) para filtrar. Formato ISO 8601 UTC.

token

string

Token de autorización **JWT** para autenticar requests posteriores. * El token es un **JWT (JSON Web Token)** codificado en Base64. * Debe incluirse en el header Authorization: Bearer {token} de requests posteriores. * Tiene un tiempo de expiración definido por seguridad. * Contiene información del usuario autenticado y permisos.

Usado en:

• POST/api/spidipagos/login(Response (200))

tokenType

string

Tipo de token de autenticación.

Ejemplo: "Bearer"

Usado en:

• POST/api/v1/merchants/auth/login(Response (200))

total

integer

Total de elementos que cumplen los filtros.

Usado en:

• GET/api/v1/ext/payment-stops(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (200))

total_amount_ves_credited

number (double)

Monto total acreditado en VES.

Usado en:

• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))

total_bank_commissions_ves

number (double)

Total de comisiones bancarias en VES.

Usado en:

• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))

total_credits

integer

Número total de créditos/liquidaciones realizados.

Usado en:

• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))

total_estimate

integer

Estimación rápida del total.

Usado en:

• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

transactionSpidi_id

number

ID de la transacción en SPIDI.

Ejemplo: 1296

transactionSpidi_url

string (uri)

URL del comprobante de pago en SPIDI (Comparar con 'receipt_url').

type

string

Error relacionado con el campo type.

Ejemplo: "Invalid value. Must be button or request"

Usado en:

• POST/api/v1/merchants(Response (400))
• POST/api/v1/merchants/auth/login(Response (401))
• POST/api/v1/merchants/{merchantId}/pos-terminals/{serialNumber}/pairing(Response (400))
• POST/api/v1/pos-terminals/{serialNumber}/pairing/activate(Response (400))
• POST/api/v1/merchants/{merchantId}/transactions(Response (400))
• GET/api/v1/merchants/{merchantId}/transactions/{orderId}(Response (404))
• POST/api/v1/merchants/{merchantId}/transactions/{orderId}/cancellation(Response (409))
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Response (400))
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Response (401))
• GET/api/v1/pos-terminals/{serialNumber}/transactions(Response (403))
• GET/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}(Response (404))
• POST/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}/commit(Response (409))
• POST/api/v1/pos-terminals/{serialNumber}/transactions/{orderId}/cancellation/commit(Response (409))
• GET/api/v1/merchants/{merchantId}/pos-terminals/{serialNumber}/settlements(Response (400))
• POST/api/v1/pos-terminals/{serialNumber}/settlements(Response (400))
• GET/api/v1/pos-terminals/{serialNumber}/settlements/{batchNumber}(Response (404))
• POST/api/v1/ext/agreements(Response (400))
• POST/api/v1/ext/agreements(Response (401))
• POST/api/v1/ext/agreements(Response (403))
• POST/api/v1/ext/agreements(Response (409))
• POST/api/v1/ext/agreements(Response (422))
• POST/api/v1/ext/agreements(Response (429))
• POST/api/v1/ext/agreements(Response (500))
• POST/api/v1/ext/payment-sessions/buttons(Request)
• POST/api/v1/ext/payment-sessions/buttons(Response (200))
• POST/api/v1/ext/payment-sessions/request/batch(Request)
• POST/api/v1/ext/payment-sessions/request/batch(Response (200))

updated_after

string (date-time)

Retorna elementos con updated_at posterior a esta fecha. Formato ISO 8601.

updated_at

string (date-time)

Fecha y hora de última actualización (ISO 8601).

Usado en:

• GET/api/v1/ext/payment-stops(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}(Response (200))
• PATCH/api/v1/ext/payment-stops/{stop\_id}(Response (200))
• GET/api/v1/ext/payment-stops/{stop\_id}/payment-sessions(Response (200))
• POST/api/v1/ext/payment-stops/payment-sessions/query(Response (200))

urlRedirection

string (uri)

URL de redireción en caso de que se tenga exito o falle

urlWebhookPayStatusChange

string (uri)

URL para recibir notificaciones del cambio en el status del pago

user_message

string

Mensaje para mostrar al usuario según estado.

Usado en:

• GET/api/v1/ext/payment-sessions/status/{session\_id}(Response (200))

username

string

Sin descripción disponible.

Ejemplo: "Nombre de usuario"

userSpidi_crixtoConfig

object

Configuración para crixto del usuario SPIDI

Propiedades del objeto:

• userSpidiId:

• isActive:boolean

  Indica si la configuracion de crixto del usuario SPIDI esta activa

  Ejemplo: true

userSpidi_id

string

Identificador único de tipo UUID para el usuario SPIDI

Ejemplo: "a966ce0d-3af3-415d-ba86-1db5a1c21cf0"

userSpidi_username

string

Nombre de usuario o identificador único del comercio.

uuid

string (uuid)

Identificador único en formato UUID.

Ejemplo: "cc87b3d9-a121-4fe7-a5d0-9c0916008220/transactions/3ddc4cfb-c09a-43de-92c1-e4a069732e90"