Documentación
SmartPos API
Consultar cupones

Consultar cupones

Nivel de seguridad requerida para este servicio

Medio  Medio (accessToken)

Objetivo

Los cupones son los cobros con tarjeta. Este servicio permite consultar los cupones registrados. Las opciones de consulta incluyen un filtro amplio de combinaciones para definir los criterios de búsqueda.

Request

Method: POST
/external/card-voucher/get-by-filter
curl -X GET "https://$env/external/card-voucher/get-by-filter" \
    -H 'Authorization: $YOUR_ACCESS_TOKEN'

Request Body:

Ejemplo del Body
{
  "adminGroup": "string",
  "portfolioIds": [ int ],
  "deviceIds": ["string" ],
  "cardVoucherIds": [ int ],
  "operationIds": [ "string" ],
  "processStates": [ int ],
  "paymentMethod": "string",
  "startEntryDate": "2024-03-15T18:36:30.509Z",
  "endEntryDate": "2024-03-15T18:36:30.510Z",
  "startPaymentDate": "2024-03-15T18:36:30.510Z",
  "endPaymentDate": "2024-03-15T18:36:30.510Z",
  "orderCriteria": 1,
  "orderSet": 1,
  "pageIndex": 0,
  "pageCount": 200
}
FiltroDescripción
adminGroup(obligatorio) código del grupo administrativo a consultar. El mismo se obtiene desde el endpoint posdevice-api/get-collect-accounts
portfolioIds(opcional) listado con los Ids de las cuentas a consultar
deviceIds(opcional) listado de los dispositivos a consultar
cardVoucherIds(opcional) listado con los Ids de los cupones a consultar
operationIds(opcional) listado con los Ids de las operaciones a consultar
processStates(opcional) medio de pago utilizado. Posibles valores: NULL: Todos, DEBIT, CREDIT
startEntryDate:(opcional) fecha inicial de generación del cupón
endEntryDate:(opcional) fecha final de generación del cupón
startPaymentDate:(opcional) fecha inicial en la que se debe pagar el cupón
endPaymentDate:(opcional) fecha final en la que se debe pagar el cupón
orderCriteria:(opcional) criterio para ordenar los cupones. Posibles valores: 1: EmissionDate, 2: PaymentDate. Valor por defecto: "EmissionDate"
orderSet:(opcional) sentido del orden. Posibles valores: 1: Ascendente, 2: Descendente
pageIndex:(opcional) número de página a consultar. Valor por defecto: 0 (primer página)
pageCount:(opcional) cantidad de registros a consultar. Valor por defecto: 200 (máximo valor posible por página)

Ejemplo de Respuestas:

JSON
[
    {
        "id": 1004,
        "terminalId": "08bbb0d4-9716-4eb3-a9a6-8af070ee88cc",
        "operationType": "PAYMENT",
        "operationNumber": 784610429,
        "operationId": "9ecaadb7-0318-4b41-b13d-1932022bcbb9",
        "acquirerId": "313217929339",
        "date": "2023-05-12T17:28:50",
        "status": "APPROVED",
        "installmentsNumber": 1,
        "cardMask": "XXXXXXXXXXXX8883",
        "cardType": "DEBIT",
        "cardBrand": "MASTERCARD",
        "grossAmount": 10.00,
        "netAmount": 9.67,
        "nextPaymentDate": "2023-05-15T17:28:50",
        "portfolioId": 4565,
        "portfolioName": "Lilith",
        "buyerPersonCuitCuil": null,
        "buyerPersonName": null,
        "processedStatus": "Procesado",
        "cancelableBalance": 0.00
    },
    {
        "id": 1006,
        "terminalId": "08bbb0d4-9716-4eb3-a9a6-8af070ee88cc",
        "operationType": "ANNULMENT",
        "operationNumber": 1850112173,
        "operationId": "9307f135-14e4-421b-9d1f-76938b4542ee",
        "acquirerId": "313217929339",
        "date": "2023-05-12T17:31:43",
        "status": "APPROVED",
        "installmentsNumber": 1,
        "cardMask": "XXXXXXXXXXXX8883",
        "cardType": "DEBIT",
        "cardBrand": "MASTERCARD",
        "grossAmount": -10.00,
        "netAmount": -9.67,
        "nextPaymentDate": "2023-05-15T17:28:50",
        "portfolioId": 4565,
        "portfolioName": "Lilith",
        "buyerPersonCuitCuil": null,
        "buyerPersonName": null,
        "processedStatus": "Procesado",
        "cancelableBalance": 0.00
    },
    {
        "id": 1027,
        "terminalId": "08bbb0d4-9716-4eb3-a9a6-8af070ee88cc",
        "operationType": "PAYMENT",
        "operationNumber": 666304088,
        "operationId": "0be7aa61-6870-42bc-ab7e-dabfef5fcc3a",
        "acquirerId": "313217929422",
        "date": "2023-05-12T17:32:50",
        "status": "APPROVED",
        "installmentsNumber": 1,
        "cardMask": "XXXXXXXXXXXX8883",
        "cardType": "DEBIT",
        "cardBrand": "MASTERCARD",
        "grossAmount": 20.00,
        "netAmount": 19.34,
        "nextPaymentDate": "2023-05-15T17:32:50",
        "portfolioId": 4565,
        "portfolioName": "Lilith",
        "buyerPersonCuitCuil": null,
        "buyerPersonName": null,
        "processedStatus": "Procesado",
        "cancelableBalance": 0.00
    },
    {
        "id": 1030,
        "terminalId": "08bbb0d4-9716-4eb3-a9a6-8af070ee88cc",
        "operationType": "REFUND",
        "operationNumber": 417573655,
        "operationId": "8f2da6e2-c0b7-445c-85cc-c8bdd2b58114",
        "acquirerId": "313511962625",
        "date": "2023-05-15T11:05:09",
        "status": "APPROVED",
        "installmentsNumber": 1,
        "cardMask": "XXXXXXXXXXXX8883",
        "cardType": "DEBIT",
        "cardBrand": "MASTERCARD",
        "grossAmount": -20.00,
        "netAmount": -19.34,
        "nextPaymentDate": "2023-05-15T17:32:50",
        "portfolioId": 4565,
        "portfolioName": "Lilith",
        "buyerPersonCuitCuil": null,
        "buyerPersonName": null,
        "processedStatus": "Procesado",
        "cancelableBalance": 0.00
    }
]
Obtener cuentasIntroducción