v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Retro Requests

Retrieves the transaction retro requests of the customer.

get/customers/{customerId}/retroRequest

Query parameters

changeType''

Filters retro transaction requests. Only RETRO is applicable here.

startDatestring date

Filter results by date-range. Pass the start date in either 8601 format (YYYY-MM-DDTHH:MM:SSZ) or the local time format with timezone (YYYY-MM-DD at HH:MM:SS IST)

endDatestring date

Filter results by date-range. Pass the end date in YYYY-MM-DD format.

startIdinteger

Filter results by sequence ID (sequence in which a change happened). For example, get lists from startId 200

endIdinteger

Filter results by sequence ID (sequence in which a change happened). For example, get lists from startId 200 until endId 400.

offsetinteger

Specifies the number of initial records to skip in the results.

limitinteger

Pass the number of results that you want to see.

startLimitstring

Specifies the starting record index for pagination

Response

200

Example response

{
  "pagination": {
    "limit": 10,
    "total": 3
  },
  "data": [
    {
      "id": 38959,
      "status": "PENDING",
      "addedBy": {
        "id": 75155295,
        "code": "sant.p_123",
        "name": "sant.p_123",
        "type": "TILL",
        "referenceId": -1,
        "adminType": "GENERAL",
        "isActive": true,
        "timeZoneId": 191,
        "currencyId": 95,
        "languageId": 148
      },
      "addedByParent": {
        "id": 75152715,
        "code": "doc123",
        "name": "DocStore",
        "type": "STORE",
        "referenceId": -1,
        "adminType": "GENERAL",
        "isActive": true,
        "timeZoneId": 191,
        "currencyId": 95,
        "languageId": 148
      },
      "updatedBy": {
        "id": 75155295,
        "code": "sant.p_123",
        "name": "sant.p_123",
        "type": "TILL",
        "referenceId": -1,
        "adminType": "GENERAL",
        "isActive": true,
        "timeZoneId": 191,
        "currencyId": 95,
        "languageId": 148
      },
      "addedOn": "2025-05-02T11:53:46Z",
      "updatedOn": "2025-05-02T11:53:46Z",
      "userId": 565032200,
      "requestId": 13048217,
      "baseType": "RETRO",
      "transactionId": 323391839,
      "reqAdd": true
    }
  ]
}