---
updatedAt: 2025-11-11T00:10:06.000Z
agentTools:
  projectIndex: https://docs.interswitchgroup.com/v1.1/llms.txt
---

# Get Customer History

This endpoint will be used by providers to retrieve information of a customer from the Platform.
Please note that, currently, this request will be pass to ESB Service and not ILS Service.

> 📘 NOTE
>
> This endpoint uses the [Interswitch Auth](https://docs.interswitchgroup.com/docs/get-access-token)

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "ipg",
    "version": "1.1"
  },
  "servers": [
    {
      "url": "https://sandbox.interswitchng.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "oauth2",
        "flows": {}
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/api/v1/payment/history": {
      "get": {
        "summary": "Get Customer History",
        "description": "This endpoint will be used by providers to retrieve information of a customer from the Platform.\nPlease note that, currently, this request will be pass to ESB Service and not ILS Service.",
        "operationId": "get-customer-history",
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "SignatureMethod",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Timestamp",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "startDate",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "endDate",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "mobile",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Nonce",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "providerCode",
                  "mobile",
                  "startDate",
                  "endDate"
                ],
                "properties": {
                  "providerCode": {
                    "type": "string",
                    "description": "The Code of the Channel from which this request originates. Max length: 50"
                  },
                  "mobile": {
                    "type": "string",
                    "description": "The ID of the customer whose Information the provider is trying to get. Max length: 50"
                  },
                  "startDate": {
                    "type": "string",
                    "description": "The Date from which history will be retrieved. Format: yyyy-mm-dd. Max length: 10",
                    "format": "date"
                  },
                  "endDate": {
                    "type": "string",
                    "description": "The Date to which history will be retrieved. Format: yyyy-mm-dd. Max length: 10"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  “firstName”: “IKECHUKWU”,\n  “lastName”: “ONYEKANNA”,\n  “email”: “onyekannaikechukwu@yahoo.com”,\n  “mobile”: “2348060765123”,\n  “cards”: [\n    {\n      “bank”: “Ecobank Nigeria Plc”,\n      “maskedPan”: “506100*********8508”,\n      “trxns”: {\n      \t“WEB”: {\n      \t\t“Web_Purchase”: [\n      \t\t\t{\n      \t\t\t\t“accountNumber”: “5061000205026368508”,\n      \t\t\t\t“acquirerBank”: “First City Monument Bank Plc”,\n      \t\t\t\t“amount”: “7000.00”,\n      \t\t\t\t“cardBrand”: “Verve”,\n      \t\t\t\t“issuerBank”: “Ecobank Nigeria Plc”,\n      \t\t\t\t“merchantBiller”: “635970849187100444     www.swiftng.cLANG”,\n      \t\t\t\t“pan”: “506100*********8508”,\n      \t\t\t\t“paymentItem”: “Swift Networks Web Payments”,\n      \t\t\t\t“responseCode”: “00”,\n      \t\t\t\t“retrievalReference”: “000632677710”,\n      \t\t\t\t“transactionDate”: “2016-04-24”,\n      \t\t\t\t“transactionTime”: “08:55:49”\n    \t\t\t},\n    {\n      “accountNumber”: “5061000205026368508”,\n      “amount”: “1100.00”,\n      “cardBrand”: “Verve”,\n      “issuerBank”: “Ecobank Nigeria Plc”,\n      “merchantBiller”: “VEW/08058829183/C/     050/050      LANG”,\n      “pan”: “506100*********8508”,\n      “paymentItem”: “Verve eAccount”,\n      “responseCode”: “00”,\n      “retrievalReference”: “000622283199”,\n      “transactionDate”: “2016-04-16”,\n      “transactionTime”: “12:54:22”\n    },\n    {\n      “accountNumber”: “5061000205026368508”,\n      “amount”: “1100.00”,\n      “cardBrand”: “Verve”,\n      “issuerBank”: “Ecobank Nigeria Plc”,\n      “merchantBiller”: “VEW/07069659012/C/     050/050      LANG”,\n      “pan”: “506100*********8508”,\n      “paymentItem”: “Verve eAccount”,\n      “responseCode”: “00”,\n      “retrievalReference”: “000622237043”,\n      “transactionDate”: “2016-04-16”,\n      “transactionTime”: “12:10:45”\n\t\t},\n    {\n      “accountNumber”: “5061000205026368508”,\n      “amount”: “1100.00”,\n      “cardBrand”: “Verve”,\n      “issuerBank”: “Ecobank Nigeria Plc”,\n      “merchantBiller”: “VEW/08158173641/C/     050/050      LANG”,\n      “pan”: “506100*********8508”,\n      “paymentItem”: “Verve eAccount”,\n      “responseCode”: “00”,\n      “retrievalReference”: “000622228262”,\n      “transactionDate”: “2016-04-16”,\n      “transactionTime”: “12:02:37”\n    },\n    {\n      “accountNumber”: “5061000205026368508”,\n      “amount”: “1100.00”,\n      “cardBrand”: “Verve”,\n      “issuerBank”: “Ecobank Nigeria Plc”,\n      “merchantBiller”: “VEW/07035884094/C/     050/050      LANG”,\n      “pan”: “506100*********8508”,\n      “paymentItem”: “Verve eAccount”,\n      “responseCode”: “00”,\n      “retrievalReference”: “000622205248”,\n      “transactionDate”: “2016-04-16”,\n      “transactionTime”: “11:41:34”\n    },\n    {\n      “accountNumber”: “5061000205026368508”,\n      “amount”: “1100.00”,\n      “cardBrand”: “Verve”,\n      “issuerBank”: “Ecobank Nigeria Plc”,\n      “merchantBiller”: “VEW/08034207839/C/     050/050      LANG”,\n      “pan”: “506100*********8508”,\n      “paymentItem”: “Verve eAccount”,\n      “responseCode”: “00”,\n      “retrievalReference”: “000622178548”,\n      “transactionDate”: “2016-04-16”,\n      “transactionTime”: “11:20:25”\n    },\n    {\n      “accountNumber”: “5061000205026368508”,\n      “amount”: “1100.00”,\n      “cardBrand”: “Verve”,\n      “issuerBank”: “Ecobank Nigeria Plc”,\n      “merchantBiller”: “VEW/07059572619/C/     050/050      LANG”,\n      “pan”: “506100*********8508”,\n      “paymentItem”: “Verve eAccount”,\n      “responseCode”: “00”,\n      “retrievalReference”: “000622111380”,\n      “transactionDate”: “2016-04-16”,\n      “transactionTime”: “10:27:28”\n    },\n    {\n      “accountNumber”: “5061000205026368508”,\n      “amount”: “1100.00”,\n      “cardBrand”: “Verve”,\n      “issuerBank”: “Ecobank Nigeria Plc”,\n      “merchantBiller”: “VEW/08180176136/C/     050/050      LANG”,\n      “pan”: “506100*********8508”,\n      “paymentItem”: “Verve eAccount”,\n      “responseCode”: “00”,\n      “retrievalReference”: “000622099244”,\n      “transactionDate”: “2016-04-16”,\n      “transactionTime”: “10:17:58”\n    },\n    {\n      “accountNumber”: “5061000205026368508”,\n      “amount”: “1100.00”,\n      “cardBrand”: “Verve”,\n      “issuerBank”: “Ecobank Nigeria Plc”,\n      “merchantBiller”: “VEW/2348085713456/C/   050/050      LANG”,\n      “pan”: “506100*********8508”,\n      “paymentItem”: “Verve eAccount”,\n      “responseCode”: “00”,\n      “retrievalReference”: “000622082101”,\n      “transactionDate”: “2016-04-16”,\n      “transactionTime”: “10:04:43”\n    },\n    {\n      “accountNumber”: “5061000205026368508”,\n      “amount”: “1100.00”,\n      “cardBrand”: “Verve”,\n      “issuerBank”: “Ecobank Nigeria Plc”,\n      “merchantBiller”: “VEW/08109369399/C/     050/050      LANG”,\n      “pan”: “506100*********8508”,\n      “paymentItem”: “Verve eAccount”,\n      “responseCode”: “00”,\n      “retrievalReference”: “000621632998”,\n      “transactionDate”: “2016-04-15”,\n      “transactionTime”: “22:45:18”\n    }\n  ]\n\n}\n\n}\n\n}\n\n]\n\n}"
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false,
        "security": []
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```