API Filters

Con este endpoint es posible realizar una consulta de todos los reportes de las transacciones del usuario.

Endpoint API Filters

GET /api/v1/transaction/filter

Así mismo mediante el parámetro condition podemos colocar un query string con el criterio a filtrar de dichos los reportes. Por ejemplo:

Endpoint API Filters

GET /api/v1/transaction/filter?condition=and(transaction_id:eq:123456789123,transaction_id:btwn:123456789123|23232)

En el ejemplo anterior estamos filtrando los reportes para conseguir la transacción con el número de identificación específico, así que solo retorna una transacción.

Sintaxis

El query string está conformado por la siguiente nomenclatura:

Para colocar múltiples filtros se separa por comas, de la siguiente manera:

Campos filtrables

Valor	Descripción
user_id:	Número de identificación del sub-usuario que realizó la operación en caso de haber sido realizada por uno.
subuser_id:	Número de identificación del sub-usuario que realizó la operación en caso de haber sido realizada por uno.
internal_id:	Número de identificacion interno otorgado por el cliente.
transaction_id:	Número de identificación de la transacción en Sypago.
ref_ibp:	Número de referencia del banco.
group_id:	Número de identificación al grupo que pertenece la operación.
InitTransactionDate:	Fecha en la cual se inició la transacción.
operation_date:	Fecha en la cual se culminó la transacción.
amount_type:	Tipo de monto utilizado en la operación.
amt:	Valor del monto de la transacción.
pay_amt:	Valor del monto pagado de la transacción.
currency:	Tipo de moneda utilizada en la operación.
rate:	La tasa a la que es evaluada la moneda utilizada, para la conversión en bolívares.
name:	Nombre del usuario Receptor.
document_type:	Tipo de documento de identidad del usuario Receptor.
number:	Número de documento de identidad del usuario Receptor.
bank_code:	Código de banco de la cuenta receptora.
account_type:	Tipo de cuenta utilizada (Teléfono o Cuenta).
account_number:	Número de cuenta o teléfono del receptor.
status:	Estado de la operación.
rejected_code:	Código de rechazo en caso de estar con estado rechazado.
operationSecret:	Este UUID es generado por SyPago y retornado en la respuesta de cada solicitud de inicio de transacción. Funciona como una clave secreta compartida, transmitida una sola vez, que se utiliza para verificar la autenticidad de los mensajes. Esto asegura que tanto las notificaciones de webhook como las respuestas de checkout provienen legítimamente de SyPago.

Operadores

• eq: (Equal) igual.

Sintaxis operador eq

GET /api/v1/transaction/filter?condition=and(transaction_id:eq:123456789123)

• like: (Like) parecido.

Sintaxis operador like

GET /api/v1/transaction/filter?condition=and(transaction_id:like:123)

• lte: (Less then equal) Menor igual que.

Sintaxis operador lte

GET /api/v1/transaction/filter?condition=and(amount:lte:100)

• gte: (Greater then equal) Mayor igual que.

Sintaxis operador gte

GET /api/v1/transaction/filter?condition=and(amount:gte:1)

• btwn: (Between) Entre.

Sintaxis operador btwn

GET /api/v1/transaction/filter?condition=and(amount:btwn:10|100)

Mensaje de respuesta API Filter

[
    {
        "internal_id": "1234567890123456789",
        "transaction_id": "BB12345678B",
        "ref_ibp": "000112345678912345678912",
        "group_id": "",
        "operation_date": "2024-11-26T13:41:44.692Z",
        "amount": {
            "type": "NONE",
            "amt": 3.00,
            "pay_amt": 0,
            "currency": "VES",
            "rate": 46.64270000
        },
        "receiving_user": {
            "name": "Soluciones Sycom",
            "document_info": {
                "type": "SCID",
                "number": "J404579427"
            },
            "account": {
                "bank_code": "0001",
                "type": "CNTA",
                "number": "000112345678901234567890123"
            }
        },
        "status": "ACCP",
        "rejected_code": null
    },
]