v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Request Details

This API allows you to retrieve up to 50 records containing goodwill and change identifier requests. It is the sub-set of request/logs API.

You can filter requests by customer and request type such as change identifier, customer merge, mobile reallocation and good will requests. This API supports various filters to fetch requests.

get/request/get

Query parameters

format'xml' | 'json'

start_datestring date

Get requests added on or after a specific date (YYYY-MM-DD). To get requests for a specific duration, pass the date-range in start_date and end_date.

end_datestring date

Get requests added before a specific date (YYYY-MM-DD). To get requests for a specific duration, pass the date-range in start_date and end_date.

mobilestring

Mobile number of the customer to get requests of a specific customer.

emailstring

Email ID of the customer to get requests of a specific customer.

external_idstring

External ID of the customer to get requests of a specific customer.

idinteger

Unique ID of the customer to get requests of a specific customer.

card_numberstring

Card number of the customer to get requests of a specific customer.

card_external_idstring

External ID of the customer's card to get requests of a specific customer.

status'APPROVED' | 'PENDING' | 'REJECTED'

Filters requests by request status.

type'HANGE_IDENTIFIER' | 'GOODWILL' | 'TRANSACTION_UPDATE'

Filters requests of a specific type.

Sub type of the specified type.

start_idinteger

Get requests starting from a specific request ID. Use both start_id and end_id to get requests in a specific request ID range.

end_idinteger

Get requests until a specific request ID. Use both start_id and end_id to get requests in a specific request ID range.

limitinteger

Limit the number of entries to retrieve.

Response

200

Example response

{
  "response": {
    "status": {
      "success": "true",
      "code": "200",
      "message": "SUCCESS"
    },
    "requests": {
      "count": "531",
      "rows": "30",
      "goodwill": {
        "id": "10039",
        "type": "GOODWILL",
        "status": "PENDING",
        "base_type": "COUPON",
        "reason": "BILL_ISSUE",
        "comments": "customer is angry",
        "customer": {
          "firstname": "Tom",
          "lastname": "Sawyer",
          "email": "Tom.sawyer@example.com",
          "mobile": "44700900000",
          "external_id": "ts1234",
          "fraud_status": "CONFIRMED"
        },
        "added_on": "2016-02-12T13:32:42+05:30",
        "added_by": {
          "code": "Tom.store",
          "name": "Tom store"
        }
      },
      "change_identifier": [
        {
          "id": "10034",
          "type": "CHANGE_IDENTIFIER",
          "status": "REJECTED",
          "base_type": "EMAIL",
          "new_value": "Tom@Tom2.com",
          "old_value": "Tom@Tom.com",
          "customer": {
            "firstname": "Tom",
            "lastname": "Sawyer",
            "email": "Tom@Tom2.com",
            "mobile": "919740798372",
            "external_id": "XYPZ001",
            "fraud_status": "CONFIRMED"
          },
          "added_on": "2016-02-12T05:30:00+05:30",
          "last_action_on": "2014-02-21T05:30:00+05:30",
          "added_by": {
            "code": "Tom.store",
            "name": "Tom store"
          },
          "updated_by": {
            "code": "admin",
            "name": "Mr Admin"
          }
        }
      ],
      "item_status": {
        "success": "true",
        "code": "9000",
        "message": "Request retrieved successfully"
      }
    }
  }
}