ATatratopago

Listar pagos

Changed on
get/api/v4/integration/cash-in/payments

Request

Query parameters

paymentIdinteger

ID del pago global.

minDatestring date

Fecha mínima (YYYY-MM-DD o ISO), día completo en hora de México.

maxDatestring date

Fecha máxima (YYYY-MM-DD o ISO), día completo en hora de México.

minAmountnumber

Monto mínimo.

maxAmountnumber

Monto máximo.

storesstring

IDs de sucursal separados por coma (ej: 1,2,3). Todas deben estar autorizadas.

status'success' | 'pending_conciliation'

Estado del pago.

pageinteger

Página, empieza en 0.

limitinteger

Tamaño de página, de 1 a 100.

orderBy'paymentDate' | 'paymentAmount' | 'paymentId'

Campo de orden.

orderDirection'ASC' | 'DESC'

Dirección del orden.

Response

Lista de pagos.

totalPaymentsinteger required

Total de pagos según el filtro.

totalAmountnumber required

Monto total según el filtro.

Changes

  • 0d08bf95374bRevision changes
    • breaking

      for the query request parameter limit, default value was changed from 10 to 10

    • breaking

      for the query request parameter page, default value was changed from 0 to 0

    • breaking

      removed the enum value cancelled from the query request parameter status

    • breaking

      for the query request parameter paymentId, the type changed from string to integer

    • breaking

      the // response's property type changed from string to number for status

    • info

      for the query request parameter maxAmount, the type was generalized from integer to number

    • info

      for the query request parameter minAmount, the type was generalized from integer to number

    • info

      removed the cancelled enum value from the // response property for the response status